Get company usage summary

GET 
/wallet/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.

Request

Version stringrequired

API Version

Available optionsv3

month string

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

application/json

Usage summary retrieved successfully

application/json

Schema

Schema

usageSummaryobjectrequired

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

Example (auto)

{
  "usageSummary": {
    "total": 1284.5,
    "locationCount": 42,
    "products": [
      {
        "product": "Email",
        "amount": 420.1
      }
    ]
  }
}