Sign in
internal
workspaces

Get Billing Account

get/api/v1/internal/workspaces/{workspace_id}/billing-account

Path parameters

workspace_idstring uuid required

Response

Successful Response

workspace_idstring uuid required
plan_keystring required
plan_versionstring required
on_free_planboolean required
status'pending' | 'active' | 'past_due' | 'unpaid' | 'cancelled' required

Subscription state as MAIA understands it, not as Stripe reports it.

PAST_DUE is the retry window: full access with a visible warning. UNPAID is that window exhausted — paid work refuses until payment succeeds, but the subscription has not ended, so purchased usage is kept. CANCELLED is paid access ended. Purchased usage is kept there too — no status takes it — but only a status that keeps paid access may spend it.

anchor_dayinteger required
period_startstring date required
period_endstring date required
included_granted_usdstring required
included_consumed_usdstring required
purchased_balance_usdstring required
given_balance_usdstring required

The part of purchased_balance_usd staff gave for free.

activated_atstring date-time nullable required

Changes

Changed in 3 of the 30 revisions of this API.3