Billing
get/api/v1/billing/usage

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/billing/usage
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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

Deprecated compatibility field; zero because allowances are shared by the organization.

voice_sec_allowance_per_identityinteger required

Deprecated compatibility field; zero because allowances are shared by the organization.

allowance_scope'organization'
sms_allowance_per_org_per_cycleinteger

SMS/MMS included across the organization per billing cycle.

voice_sec_allowance_per_org_per_cycleinteger

Voice seconds included across the organization per billing cycle.

sms_allowance_usedinteger

Debits against the shared SMS/MMS allowance.

voice_sec_allowance_usedinteger

Debits against the shared voice allowance, in seconds.

sms_allowance_remaininginteger

Shared included SMS/MMS remaining.

voice_sec_allowance_remaininginteger

Shared included voice seconds remaining, before minute packs.

sms_allowance_creditinteger

Additional included SMS/MMS preserved for this cycle.

voice_sec_allowance_creditinteger

Additional included voice seconds preserved for this cycle.

overage_cap_centsinteger nullable

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

overage_spend_centsinteger nullable

Contract-priced SMS and voice overage in cents; null when historical pricing is unavailable.

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).

voice_pack_sec_grantedinteger

Voice seconds available this cycle from minute packs, shared across the org. Drawn after each identity's included allowance and before overage.

voice_pack_sec_usedinteger

Minute-pack voice seconds used so far this cycle.

Changes

    • breaking

      response property overage_spend_cents list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property sms_allowance_per_identity deprecated

    • info

      response property voice_sec_allowance_per_identity deprecated