Billing

Your plan, seats, usage this period, and whether new calls are stopped

GET /v1/billing billing:read

Responses

• 200

  The billing status

  Fields

  • data BillingStatus required
    Fields

    • enabled boolean required
    • exempt boolean required
    • plan "build" | "team" | "scale" | null required
    • interval "month" | "year" | null required

      How the plan bills. Null: no plan yet

    • status string required
    • stopped "billing_required" | "billing_past_due" | "billing_disputed" | "usage_limit_reached" | "plan_has_no_seats" | "test_cap_reached" | null required

      Why new live calls are stopped. Null: they are not

    • seats object required
    • nextChargeCents number | null required

      The renewal at today’s seats, before tax and any discount. Null: none coming

    • overageCents number required

      Past the allowance so far this period

    • currentPeriodEnd string | null required
    • cancelAt string | null required
    • usagePeriodEnd string | null required
    • spendCapCents number | null required
    • usage object[] required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code