Versions Compared

Old Version 8

changes.mady.by.user Panagiotis Papanastasiou

Saved on

compared with

New Version Current

changes.mady.by.user Panagiotis Papanastasiou

Saved on

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
typenote

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
Rw tab
titleSubscription Management Endpoints for (White-Label) Free Edition Resellers

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.

Rw tab
titleSubscription Management Endpoints for (White-Label) 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 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

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.

The following endpoint can be used to cancel an add-on ofa subscription, at the end of the billing period:

  • POST /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

  • /addons/{addonId}/cancelendofbillingperiod

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.

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

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

  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. ←Remember here to add the parameter of the “subscription ID”.

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

  • 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 given request ID of the given add-on ID.

Table of Contents

Table of Contents
maxLevel6
minLevel1
include
outlinefalse
indent
excludeTable of Contents
stylenone
typelist
printabletrue
class

Rw ui textbox macro
typeinfo

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.