訂閱綁定一個顧客與一個週期性價格。建立與取消都是需要 Idempotency-Key 的財務操作。
GET/api/Subscription— 列出訂閱
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
POST/api/Subscription— 建立一個新訂閱(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
customerId | body | string | |
metadata | body | object | |
paymentMethodId | body | string | |
paymentMethodRefId | body | string | |
priceId | body | string | |
GET/api/Subscription/{subscriptionId}— 讀取單一訂閱
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
subscriptionId | path | string | 必填 |
POST/api/Subscription/{subscriptionId}/Cancel— 取消訂閱(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
subscriptionId | path | string | 必填 |
immediate | body | boolean | |
GET/api/Subscription/{subscriptionId}/Change— 訂閱:Change。
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
subscriptionId | path | string | 必填 |
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
POST/api/Subscription/{subscriptionId}/Command— 訂閱:Command。
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
subscriptionId | path | string | 必填 |
effectiveAt | body | string (date-time) | |
expectedVersion | body | string | |
priceId | body | string | |
reason | body | string | |
type | body | string | |
POST/api/Subscription/{subscriptionId}/Preview— 訂閱:Preview。
| 屬性 | 值 |
|---|
| 所需權限 | subscriptions:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
subscriptionId | path | string | 必填 |
priceId | body | string | |