Billing

Get billing summary

Changed on

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

get/billing/summary

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/billing/summary
  • Auth: none declared

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 billing cycle (billing_plans.config.cycleCredits). Additive, never a balance target.

targetCreditBalancestring nullable required

Changes

  • ce96861cea60Revision changes
    • info

      added the required property to the response with the status

  • 91462dbc8cebRevision changes
    • warning

      added the new log_queries_executed enum value to the /////// response property for the response status

    • warning

      added the new log_queries_executed enum value to the ///// response property for the response status

    • warning

      added the new log_questions_answered enum value to the /////// response property for the response status

    • warning

      added the new log_questions_answered enum value to the ///// response property for the response status