Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Get Subscriptions for Customer

Retrieves the subscriptions, including all subscription items, for a particular customer using the customer ID, the customer reference ID , or the customer's email address. Subscription items contain the current status and a list of all related purchases.<br /> For XML examples and schemas, see the Additional Examples - Get Subscriptions for Customer.

get/subscription/getsubscriptionsforcustomer

Query parameters

customerEmailstring

Email address of the customer.

customerIdstring

Cleverbridge's unique ID for a customer.

customerReferenceIdstring

Your unique ID for the customer. This value is submitted by you when the customer initially purchases the subscription and is stored by Cleverbridge. Corresponds to the <b>Internal customer ID</b> in the Cleverbridge platform. For more information, see Customer Data.

subscriptionstatusstring

Status of the subscription. Restricts the response to subscriptions with the specified status: <code>Active</code>, <code>Deactivated</code>, <code>Finished</code>, <code>Grace</code>, <code>Hold</code>, or <code>New</code>.

isCurrentboolean

Set to <code>true</code> if you want to retrieve data only for items where <code>IsCurrent</code> is set to <code>true</code>. By default all the data is returned.

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Response

OK

ResultMessagestring

Optional result or error message.