List Account's Subscriptions

get

https://{subdomain}.{domain}/v2/accounts/{account_code}/subscriptions

Returns a list of subscriptions for an account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_code

string

required

Unique account identifier.

Query Params

state

string

The state of subscriptions to return: active, paused, canceled, expired, future, in_trial, live, or past_due. A subscription may belong to more than one state. Please see the previous section for a note on subscription states.

cursor

string

Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.

sort

string

Defaults to created_at

The attribute that will be used to order records: created_at, updated_at.

order

string

Defaults to desc

The order in which products will be returned: asc for ascending order, desc for descending order.

begin_time

date-time

Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.

end_time

date-time

Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.

per_page

integer

Defaults to 50

Number of records to return per page, up to a maximum of 200.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/xml