Sign in
Billing

Get billing summary

Get a billing summary for the current organization, including plan, balance, and cycle information.

get/billing/summary

Query parameters

organizationIdstring

Organization to query billing for. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Response

OK

billingModel'credit-balance-v1' required
billableboolean required
nonBillableReasonstring nullable required
statusstring required
planNamestring nullable required
planSlugstring nullable required
currencystring nullable required
currentBalancestring nullable required
cycleCreditsstring nullable required

Credits added to the balance each paid cycle (billing_plans.config.cycleCredits). Additive, never a balance target.

targetCreditBalancestring nullable required

Changes

Changed in 1 of the 4 revisions of this API.4

  • f7ae8f7754564See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property //// to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added