Skip to main content
GET
List customer accounts

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

merchantId
string
required

Merchant whose customer accounts to report Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
customerIds
string[]

Limit the rows and the totals to these customers of the merchant. A customer of another merchant, or one that does not exist, returns 404. A customer billed in several currencies has a row for each, so set limit to cover them.

Required array length: 1 - 100 elements
Minimum string length: 1
limit
integer
default:50

Number of rows to return

Required range: 1 <= x <= 500
offset
integer
default:0

Number of rows to skip

Required range: x >= 0

Response

Customer accounts

object
enum<string>
required

Object type identifier

Available options:
list
totals
object[]
required

One entry per currency with at least one row in the filter, over every row and not only this page. The merchant's primary currency comes first, then the rest in alphabetical order. Empty when there are no rows.

data
object[]
required

One row per customer and currency with at least one unpaid invoice, in the currency order of totals, then by outstanding.amount descending, then by customerId. A customer billed in two currencies has two rows.

pagination
object
required

Offset-based pagination response.