Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Accounts

List all accounts

Returns a list of your accounts.

If no parameters are sent, the operation will return an array of account IDs.

get/accounts

Query parameters

emailstring
Example:first.last@domain.com

Only return accounts with the given email address.

customstring
Example:customKey

Only return accounts with the given custom lookup key.

globalstring
Example:ab-Cd9e8F6ghiJ-Okl3M3n

Only return accounts with the given global lookup key.

orderIdstring
Example:aAB0cdefGHiJkL0m8n8OpQ

Only return accounts with the given order ID.

orderReferencestring
Example:ABC230906-7581-30108

Only return accounts with the given order reference.

subscriptionIdstring
Example:84a1bCDEf86g_-HijK_LMN

Only return accounts with the given subscription ID.

productsstring
Example:product-testing

Only return accounts with the given product ID.

subscriptions'active' | 'ended' | 'canceled' | 'started'

Only return accounts with subscriptions in the corresponding state.

refundsstring
Example:true

Only return accounts that include refunds. You can only pass the value 'true' for this parameter.

limitnumber
Example:50

A limit on the number of objects to be returned per page (default limit is 50).

pagenumber
Example:1

Specify which page of results should be returned.

Response

OK

actionstring

The action performed by the API call.

resultstring

Indicates that the request has succeeded or failed.

pageinteger

The page number of results returned.

limitinteger

The limit of how many objects were returned per page.

nextPageinteger

The next page number of results returned.

totalinteger

The total number of accounts returned.

Example response

{
  "action": "account.getall",
  "result": "success",
  "page": 1,
  "limit": 50,
  "nextPage": 2,
  "total": 2,
  "accounts": [
    "aAB0cdefGHiJkL0m8n8OpQ",
    "rST2uv1wXy279zABCd_E2f"
  ]
}
All 75 operations