Skip to main content
GET
List Accounts
Returns the accounts belonging to a customer, newest first. Deleted accounts are never listed. Each item is a summary: it carries a balance snapshot but not the account’s identity details. Use Get Account for the full object. Requires an API key with read access on the accounts scope.

Path Parameters

string
required
The customer’s external ID (starts with cus_)

Query Parameters

integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)
array
Filter by account status. Repeat the key once per value: ?statuses=active&statuses=suspended. Allowed values are active, suspended and deactivated, lowercase; anything else returns 422.
string
Return accounts created on or after this timestamp, inclusive (ISO 8601)
string
Return accounts created before this timestamp, exclusive (ISO 8601)

Response

Items are ordered by creation time, newest first.
array
Account summary objects, newest first
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Errors

Response Example