Management API

Base Resource URL:



Allows to manage the subscriptions associated with the specified customer.

Available sub-resources:

Resource URL Description
https://[server-name]/api/v01/customers/[customer-id]/subscriptions/[subscription-id]    Allows to manage the specified subscription.

Supported Actions:

Method:  PUT       Implicit:  Yes       Returns:  Subscription *      
Consumes:  json, xml, query  Produces:  json, xml, query 
Creates a subscription.

# Name Type Required Default Description
01 object Subscription * Yes Information about the subscription transaction.

Method:  GET       Implicit:  Yes       Returns:  Subscription[] *      
Consumes:  query  Produces:  json, xml 
Returns a list of available subscriptions.

# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 100 Maximum number of records to load per single search web call made by the customer.
03 createDate Date No Date when the subscription was created.
04 planId Long No Unique identifier of a plan associated with the subscription. Provided by the gateway.
05 nextBillingDate Date No Date when the next billing is going to occur.
06 status Enum No Status of a subscription.