Billing

Get billing state

Returns the organization’s provider-neutral billing state: subscription status, plan-differentiated capability flags, the AI credit meter, the prepaid credit balance purchased through top-ups, credits granted by Cactal support with their remaining balance and expiry, and capacity for websites with custom domains. Requires the organization owner.

get/billing/state

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/billing/state
  • Auth: HTTP bearer

Query parameters

organizationIdstring required

Response

Current billing state for the organization.

organizationIdstring required

Organization this billing state belongs to.

status'no_subscription' | 'active' | 'billing_grace' required

Provider-neutral subscription status. billing_grace means past due: existing websites keep serving, but paid changes and metered consumption are blocked. The auto-enabled free plan reports no_subscription.

complimentaryboolean required

True when the organization has the manually assigned, no-charge complimentary plan.

capabilitiesobject required

Plan-differentiated product capabilities currently available to the organization.

metersobject required

Customer-facing usage meters keyed by meter ID.

billableSiteCapacitynumber

Total capacity for websites with custom domains. Omitted when the provider does not report it.

billableSiteCountnumber

Number of websites with at least one custom domain.

Changes

No recorded changes to this operation across all 1 revision of this API.