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 Retrieve all Subscriptions

• GET /api/subscriptions - By invoking this call, the Reseller API user will retrieve all the subscriptions.

How to Retrieve Information from a Specific Subscription

• GET /api/subscriptions/{subscriptionId} - By invoking this call, the Reseller API user will retrieve information from a specific subscription, based on the given subscription ID.

How to Retrieve the Characteristics of a Specific Subscription

• GET /api/subscriptions/{subscriptionId}/characteristics - By invoking this call, the Reseller API user will retrieve the characteristics from a specific subscription, based on the given subscription ID.

How to Retrieve the Installment Plan of a Specific Subscription

• GET /api/subscriptions/{subscriptionId}/currentInstallmentplan - By invoking this call, the Reseller API user will retrieve the installment plan (if applicable) from a specific subscription, based on the given subscription ID.

How to Retrieve the Custom Fields of a Specific Subscription

• GET /api/subscriptions/{subscriptionId}/customfields - By invoking this call, the Reseller API user will retrieve the custom fields from a specific subscription, based on the given subscription ID.

How to Cancel 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.

How to Decrease the Quantity of a Subscription

• 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.

How to Increase the Quantity of a Subscription

The following process can be used to increase the quantity of a subscription:

1. You first have to create a draft order by invoking this call POST api/orders.

2. Then you need to add order item(s) by invoking this call POST /api/orders/{orderid}/items.

3. Lastly, you need to checkout that order by invoking this call POST /api/orders/{orderid}/checkout.
   

How to Check the State of the Quantity Decrease Request of a Subscription

• GET /api/subscriptions/{subscriptionId}/quantityrequest/{requestId}: By invoking this call, the Reseller API user will retrieve the state of the quantity change (decrease) request, based on the given request ID.