Manage a subscription
Last updated
Admin APIs reference
Last updated
This will update subscription expiration date
/v1/subscriptions/{subId}/expiration-date
Subscription Id
Basic authorization (dispatch Key and Secret)
The subscription expiration date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".
No body
This will cancel the subscription by subscription Id and Subscription state changes to Cancelled
/v1/subscriptions/{subId}/cancel
Subscription Id
Basic authorization (dispatch Key and Secret) or Full access token
The clients can use this element to suppress cancel notification email.By default this is false.
Optional, you can specify the codes used to categorize the reason for the subscription cancellation. This field can contain up to 64 characters.
An optional comment provided by the shopper detailing additional information or context regarding the subscription cancellation. This field can contain up to 255 characters.
No body
This will activate the subscription.The subscription state changes from PendingActivation to Subscribed
/v1/subscriptions/{subId}/activate
Subscription Id
Basic authorization (dispatch Key and Secret)
The subscription activation key
The subscription activation date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".
The subscription expiration date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".
No body