List Accounts

get

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

Returns a list of accounts on your site. Results are ordered by the time created, sorted by newest first.

Account Query States

state	description
`active`	Open accounts.
`closed`	Accounts that are not open.
`subscriber`	Accounts with subscriptions that are valid for the current time. This includes subscriptions in a trial period.
`non_subscriber`	Accounts without subscriptions that are valid for the current time.
`past_due`	Accounts with invoices that have failed initial collection but still have collection attempts remaining.

Please note: a queried state and the base state of a returned account may differ. For example, querying for past_due account will not result in a list of accounts with a past_due state (they will either be active or closed). Only base states (active, closed) will be present in the returned account records.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

state

string

The state of accounts to return: active, closed, subscriber, non_subscriber, past_due.

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.

cursor

integer

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.

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