Skip to main content
GET
Get billing state

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

organizationId
string
required
Minimum string length: 1

Response

Current billing state for the organization.

organizationId
string
required

Organization this billing state belongs to.

status
enum<string>
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.

Available options:
no_subscription,
active,
billing_grace
complimentary
boolean
required

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

capabilities
object
required

Plan-differentiated product capabilities currently available to the organization.

meters
object
required

Customer-facing usage meters keyed by meter ID.

creditGrants
object[]
required

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.

subscription
object

Current paid subscription metadata. Omitted on the free plan or when the provider does not report one.

usageBalance
object

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.

billableSiteCapacity
number

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

billableSiteCount
number

Number of websites with at least one custom domain.