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.

Please Note That the Subscription Management Endpoints Found on this Page are Applicable Only to White-Label Resellers (Free Edition & Standard Edition) and Depend on the Edition of the Reseller.

The Free Edition Resellers can only retrieve information about subscriptions.

The following endpoint can be used to retrieve information from all the subscriptions:

• GET /api/subscriptions - Retrieves all the subscriptions.
  

The following endpoint can be used to retrieve information from a specific subscription:

• GET /api/subscriptions/{subscriptionId} - Retrieves a specific subscription based on the given ID.
  

The following endpoint can be used to retrieve characteristics from a specific subscription:

• GET /api/subscriptions/{subscriptionId}/characteristics - Retrieves the characteristics of a specific subscription based on the given ID.
  

The following endpoint can be used to retrieve the installment plan of a specific subscription:

• GET /api/subscriptions/{subscriptionId}/currentInstallmentplan - Retrieves the installment plan (if applicable) of a specific subscription based on the given ID.
  

The following endpoint can be used to retrieve the custom fields of a specific subscription:

• GET /api/subscriptions/{subscriptionId}/customfields - Retrieves the custom fields of a specific subscription based on the given ID.
  

The following endpoint can be used to retrieve information about the state of the quantity change (decrease) request:

• GET /api/subscriptions/{subscriptionId}/quantityrequest/{requestId} – Retrieve the state of the quantity change (decrease) request.

The Standard Edition Resellers can manage subscriptions via the API.
Therefore, the Standard Edition Reseller has all the endpoints of the Free Edition Reseller as well as the following:

The following endpoint can be used to cancel a subscription, immediately:

• POST /api/subscriptions/{subscriptionId}/cancel
  

The following endpoint can be used to decrease the quantity of a subscription, immediately:

• POST api/subscriptions/{subsriptionId}/quantity (decrease)

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

1. You first have to create a draft order by utilizing the POST api/orders endpoint.

2. Then you need to add order item(s) by utilizing the POST /api/orders/{orderid}/items endpoint.

3. Lastly, you need to checkout that order by utilizing the POST /api/orders/{orderid}/checkout endpoint.