DashboardsVersion: v3

List usage records per sub-account

GET/wallet/usage-records/by-location

Fetch per-sub-account usage rows for the agency resolved from the access token. Supports skip/limit pagination, a name search, and sorting by total or by a specific month.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:wallet.readonly

Auth methods:OAuthPrivate Integration

Token type:Agency Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Query Parameters

skipnumber

Number of sub-accounts to skip for pagination. Defaults to 0.

Possible values: >= 0

Example:0

limitnumber

Maximum number of sub-accounts to return. Capped at 100 per request.

Possible values: >= 1 and <= 100

Example:25

querystring

Free-text search across sub-account names.

Example:acme

sortBystring

Field to sort by: total, or a specific month as YYYY-MM. Allowlisted -- an arbitrary value is rejected rather than passed to the query.

Example:total

sortOrderstring

Sort direction.

Available optionsascdesc

Example:desc

Response

application/json

Usage records retrieved successfully

locationsarray[]required

Per-sub-account usage rows for the agency, ordered by the requested sort.

monthsarray[]required

Months covered by the reported window, oldest first.

Example:["2024-01","2024-02","2024-03"]