Get company usage summary

Fetch aggregated usage for the agency resolved from the access token, including per-product totals. Defaults to the last six months, or a single month when month is supplied.

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

monthstring

Month to report on, as YYYY-MM. Defaults to the last six months when omitted.

Example:2024-03

Response

200

application/json

Usage summary retrieved successfully

usageSummaryobjectrequired

Aggregated usage for the agency across the reported window, including per-product totals.

Show child attributes