Skip to main content

The current subscription and the active contacts consumed so far this billing month.

generatedAt
string<date-time>
required

When this response was produced.

timeZone
string
required

The timezone every date in this response is expressed in. Always UTC.

billingScope
enum<string>
required

Whether billing is settled for a whole organization or for each team on its own. organization means every team draws on one subscription and one shared pool of active contacts. team means each team carries its own subscription and its own pool.

Available options:
team,
organization
subscription
Billing Subscription · object
required

The subscription the figures are billed against. Under organization scope this is the subscription held by the organization owner's team; under team scope it is your own team's.

activeContacts
Active Contacts Billing · object
required

Active contacts usage, shaped by billingScope. Exactly one of the two properties carries data: organization when the scope is organization, teams when it is team. The other is null.