訂閱 (Subscriptions)

訂閱的建立、讀取與取消。

檢視 Markdown

訂閱綁定一個顧客與一個週期性價格。建立與取消都是需要 Idempotency-Key 的財務操作。

GET/api/Subscription— 列出訂閱
屬性值
所需權限subscriptions:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/Subscription— 建立一個新訂閱(需要 Idempotency-Key)
屬性值
所需權限subscriptions:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
customerIdbodystring
metadatabodyobject
paymentMethodIdbodystring
paymentMethodRefIdbodystring
priceIdbodystring
GET/api/Subscription/{subscriptionId}— 讀取單一訂閱
屬性值
所需權限subscriptions:read
Idempotency-Key不需要
參數位置型別必填
subscriptionIdpathstring必填
POST/api/Subscription/{subscriptionId}/Cancel— 取消訂閱(需要 Idempotency-Key)
屬性值
所需權限subscriptions:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
subscriptionIdpathstring必填
immediatebodyboolean
GET/api/Subscription/{subscriptionId}/Change— 訂閱:Change。
屬性值
所需權限subscriptions:read
Idempotency-Key不需要
參數位置型別必填
subscriptionIdpathstring必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/Subscription/{subscriptionId}/Command— 訂閱:Command。
屬性值
所需權限subscriptions:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
subscriptionIdpathstring必填
effectiveAtbodystring (date-time)
expectedVersionbodystring
priceIdbodystring
reasonbodystring
typebodystring
POST/api/Subscription/{subscriptionId}/Preview— 訂閱:Preview。
屬性值
所需權限subscriptions:write
Idempotency-Key不需要
參數位置型別必填
subscriptionIdpathstring必填
priceIdbodystring