Sign in
Billing

Get workspace billing

Get the billing state and entitlement for a workspace. When the instance has no billing configured this reports billingEnabled: false and an always-active entitlement.

get/billing/{workspaceId}

Path parameters

workspaceIdstring required

Response

Billing state for the workspace

billingEnabledboolean required

False when the instance has no billing configured.

foundingFreeboolean required
trialEndsAtstring date-time nullable required
planstring nullable required

personal or team.

billingIntervalstring nullable required

monthly or annual.

statusstring nullable required

The provider's subscription status.

seatsnumber required
currentPeriodEndstring date-time nullable required
canceledAtstring date-time nullable required
hasCustomerboolean required

Whether a billing customer exists yet. The portal link requires one.

Changes