Managing Subscriptions via API for White-Label Resellers
- Panagiotis Papanastasiou
On this page, you can find an introduction to all the Subscription Management Endpoints of the API V.3 that are available to White-Label Resellers (Free Edition & Standard Edition). You will also find flow examples, expected results, and extensive explanations for each Subscription Management Endpoint.
Subscription Management Endpoints for White-Label Resellers
In the following two tabs, you can find the available Subscription Management Endpoints for each Reseller based on their Edition, Free and Standard.
How to Manage a Subscription
In the following bullets below, you can find the three main processes of managing White-Label Reseller subscriptions via the API. These are the cancelation as well as the decrease, and the increase of quantities inside a subscription.
POST /api/subscriptions/{subscriptionId}/cancel: By invoking this call, the Reseller API user will cancel a subscriptions, immediately, based on the given subscription ID.
POST api/subscriptions/{subsriptionId}/quantity (decrease): By invoking this call, the Reseller API user will create a quantity decrease request, that has immediate effect, based on the given subscription ID.
After the quantity decrease call, because of its asynchronous functionality, you can invoke the following call GET /api/subscriptions/{subscriptionId}/quantityrequest/{requestId} to retrieve the state of the quantity change (decrease) request, so as to verify its completion.
To increase the quantity of a subscription, you need to place an order. When adding the order item for which you want to increase the quantity, you also need to provide the "subscription ID" parameter. This parameter is very important since it directly relates the order with the subscription for which you wish to perform the quantity increase. The ordering process is explained in detail in the Ordering via API for White-Label Resellers | General Flow of Order Creation & Execution via API V3 page. However, for your convenience, you can check the three main steps here as well:
You first have to create a draft order by invoking this call POST api/orders.
Then you need to add order item(s) by invoking this call POST /api/orders/{orderid}/items. ← Remember here to add the parameter of the “subscription ID”.
Lastly, you need to checkout that order by invoking this call POST /api/orders/{orderid}/checkout.
POST /api/subscriptions/{subscriptionId}/addons/{addonId}/cancelendofbillingperiod: By invoking this call, the Reseller API user will cancel the add-on of a subscription, at the end of the billing period, based on the ID of the given add-on ID.
Table of Contents