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.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Query Parameters
1Response
Current billing state for the organization.
Organization this billing state belongs to.
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.
no_subscription, active, billing_grace True when the organization has the manually assigned, no-charge complimentary plan.
Plan-differentiated product capabilities currently available to the organization.
Customer-facing usage meters keyed by meter ID.
Credits granted to the organization by Cactal support. Spent after the monthly allowance and before purchased credits; grants with an expiry are spent soonest first.
Current paid subscription metadata. Omitted on the free plan or when the provider does not report one.
Prepaid credit balance purchased through top-ups. These credits never expire and are consumed after the monthly allowance. Omitted when the provider does not report it.
Total capacity for websites with custom domains. Omitted when the provider does not report it.
Number of websites with at least one custom domain.