Retrieve a Subscription List

Query Params
number
Defaults to 10
number

Unix timestamp for created date start filter (inclusive)

string

Unix timestamp for created date start filter (inclusive)

string
required

Comma separated string of unique customer IDs for the customers for which we want to retrieve subscriptions

string
enum
required

Comma separated string of subscription status enums

string
required

Comma separated string of site IDs

string
enum
required

Comma separated string of collection_method enums

Allowed:
string

This is a base64 encoded string for pagination. It will allow you to retrieve the next set of records from the backend.

The token is made up by concatenating the following parameters with a pipe separator “|”:

  • created (cdt)
  • subscriptionId (pid)
string
enum

Comma separated string of field expansion enums.

  • recurring_items : Will expand the list of recurring_items. Only retrieve 5 max per record
  • one_time_items: Will expand the list of one_time_items. Only retrieve 5 max per record
  • customer: Will expand the customer associated with the subscription
  • site: Will expand the site associated with the subscription
Allowed:
Headers
string
required

Secret key associated to the partner’s account

string
required

Unique key generated by the partner

string

AccountId of the merchant that will own the product

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json