Sign in
Billing

Get Usage

get/api/v1/billing/usage

Response

Successful Response

cycle_startinteger required

Unix seconds for the start of the current usage cycle.

cycle_endinteger nullable

Unix seconds for the end of the current usage cycle (Stripe period end, or the calendar-month boundary for orgs with no subscription).

planstring required

Org's current plan (free/hobbyist/developer/startup/enterprise).

sms_allowance_per_identityinteger required

Included SMS allowance per phone-enabled identity per cycle (0 on Free).

voice_sec_allowance_per_identityinteger required

Included voice allowance per phone-enabled identity per cycle, in seconds.

overage_cap_centsinteger nullable

Org's monthly SMS+voice overage spend limit in cents; None when unset.

overage_spend_centsinteger

Estimated SMS+voice overage spend so far this cycle, in cents (the figure the overage spend limit is enforced against).

imessage_shared_messagesinteger

Shared-pool iMessage messages this cycle (both directions) — the count the plan's shared iMessage cap is enforced against.

imessage_dedicated_messagesinteger

Dedicated-line iMessage messages this cycle (both directions) — the count the dedicated-line cap is enforced against.

imessage_unique_recipientsinteger

Unique shared-pool iMessage recipients this cycle — the count the plan's unique-recipient cap is enforced against.

identities_usedinteger

Non-deleted agent identities in the org — the count the plan's identity cap is enforced against on create.

identities_includedinteger

Agent identities included in the plan (resolved IDENTITIES_ACTIVE quota).

Changes