List usage records per sub-account

GET 
/wallet/company/locations/usage-records

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.

Request

Version stringrequired

API Version

Available optionsv3

skip number

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

Possible values: >= 0

limit number

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

Possible values: >= 1 and <= 100

query string

Free-text search across sub-account names.

sortBy string

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

sortOrder string

Sort direction.

Available optionsascdesc

application/json

Usage records retrieved successfully

application/json

Schema

Schema

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 (auto)

{
  "locations": [
    {
      "locationId": "AUKAtFVo0lWezBsBQ3FE",
      "locationName": "Acme Dental",
      "total": 128.45,
      "months": {
        "2024-03": 42.1
      }
    }
  ],
  "months": [
    "2024-01",
    "2024-02",
    "2024-03"
  ]
}