Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Excerpt |
|---|
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. |
| Rw ui textbox macro | ||
|---|---|---|
| ||
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. |
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.
| Rw tab | ||
|---|---|---|
|
The Free Edition Resellers can only retrieve information of subscriptions.
The following endpoint can be used to retrieve information about the state ofthe
quantity change (decrease) request:GET /api/subscriptions/{subscriptionId}/quantityrequest/{requestId} – Retrieve the state of the quantity change (decrease) request.
Standard Edition Resellers
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)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 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.
Table of Contents
| Table of Contents | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Rw ui textbox macro | ||
|---|---|---|
| ||
API V.3 Endpoints for Ordering for White-Label Resellers On the following page, Ordering via API for White-Label Resellers White-Label Resellers can find all the available API V.3 Endpoints for placing Orders. |