Subscriptions APIs
Contents
Overview
Subscriptions allow you to bill an Account over time and/or on a recurring basis. A subscription ties an Account to a particular billing plan and set of purchased products (subscription items) that you have created.
Subscriptions APIs
The following table lists and describes the communications service provider (CSP) APIs you can use to create, update, and amend/modify subscriptions.
| API | Description |
|---|---|
| GET /v2/subscriptions | This APi retrieves a list of subscriptions. Note: This API can be used to get a cross-account list of subscriptions, or to get a list of subscriptions for a given account using the account query parameter. |
| GET /v2/subscriptions/{id} | This API retrieves a specific subscription. |
| POST /v2/subscriptions | This API creates a subscription. |
| POST /v2/subscriptions/{id} | This API updates, amends, or modifies a subscription. |
| POST /v2/subscriptions/{id}/actions/cancel | This API cancels a subscription.
Note: This API has the following user options: you can select immediate disentitlement versus registering the cancel now to take affect at the end of the current period, you can select whether any pre-paid services should get a prorated refund, and you can select whether or not an existing minimum commitment should be honored. The reason for the cancellation can also be tracked using Cancel Reason codes (which can use pre-defined codes or codes you’ve designed yourself in advance). |
MarketONE Developer Portal
Please refer to the MarketONE APIs - V2 section under the API Reference menu on the MarketONE Developer Portal for an OpenAPI instance of these APIs.
Revision History
| Version | Description |
|---|---|
| 2020.01 | Added this topic. |
| 2020.05 | Added the MarketONE Developer Portal section. |