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 ui tabs macro | ||||||||
|---|---|---|---|---|---|---|---|---|
The Free Edition Resellers can only retrieve information about subscriptions.
The following endpoint can be used to retrieve information from a specific subscription:
The following endpoint can be used to retrieve characteristics from a specific subscription:
The following endpoint can be used to retrieve the installment plan of a specific subscription:
The following endpoint can be used to retrieve the custom fields of a specific subscription:
The following endpoint can be used to retrieve information about the state of the quantity change (decrease) request:
The Standard Edition Resellers can manage subscriptions via the API. The following endpoint can be used to cancel a subscription, immediately:
The following endpoint can be used to decrease the quantity of a subscription, immediately:
The following process can be used to increase the quantity of a subscription:
|
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
GETThe following endpoint can be used to cancel an add-on ofa subscription, at the end of the billing period:
|
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 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.
How to Increase the Quantity of a Subscription
The following process can be used to increase the quantity of a subscriptionAfter 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 https://interworkscloud.atlassian.net/wiki/spaces/ICPD/pages/1168408577/Ordering+via+API+for+White-Label+Resellers#General-Flow-of-Order-Creation-%26-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.
How to Check the State of the Quantity Decrease Request of a Subscription
GET POST /api/subscriptions/{subscriptionId}/quantityrequestaddons/{requestIdaddonId}/cancelendofbillingperiod: By invoking this call, the Reseller API user will retrieve the state of the quantity change (decrease) requestcancel the add-on of a subscription, at the end of the billing period, based on the ID of the given request add-on 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. |