Metered domain usage, plan, and quota for the caller's tenant

The tenant the usage belongs to, derived from the authenticated credential.

UTC calendar month, YYYY-MM.

metered domain connections this period

The Stripe key mode the control plane is running against; empty when billing is unconfigured.

free is retired: legacy workspaces still carry it until they subscribe, and it cannot be bought or assigned.

The plan's display name, e.g. Growth.

The plan's included domain connections for ONE billing MONTH (DomainsPerYear ceiling-divided by 12; 0 = unlimited). Compare used against this. limit carries the identical value.

Alias of quota, carrying the identical value. This schema declared limit while the handler emitted only quota; rather than break either reader, both are emitted. Prefer quota in new code.

true on tiers priced for overage (growth, enterprise). It carries NO enforcement meaning; it describes pricing only. Read hard_cap for the plan's refusal policy and quota_enforced for whether a 402 is possible right now. Never branch on this field.

Whether this PLAN refuses connections past quota (402 quota_exceeded) rather than allowing and recording them as overage. true only on the entry tiers: starter ($10 a month) and the retired free. Every larger tier (startup, premium, growth, enterprise) is false and is never refused at quota. The refusal reaches the tenant's own end users through the embedded widget, so it is worded neutrally for them. Independent of the deployment's BILLING_ENFORCE_QUOTA; combine the two via quota_enforced.

The server's classification of used against quota. approaching means at or past 80% of quota; at_limit means used >= quota. Always ok on an unlimited plan (quota <= 0).

Whether an over-quota connection would actually be refused with 402 quota_exceeded right now. True only when the plan's hard_cap is set AND the deployment enables enforcement. A client cannot infer the second half, which is why this is served rather than derived. On every paid tier it is false at any usage level. A tenant may therefore be at_limit with quota_enforced: false (over the line with nothing refused), so never treat at_limit alone as "blocked". Always false on an unlimited plan.

quota - used, floored at 0. Omitted entirely on an unlimited plan, where no remainder is meaningful.

Subscription status mirrored from Stripe, e.g. active, past_due (empty for a workspace that has not subscribed). Owners and admins only.

true when a Stripe customer exists for the org, i.e. the billing portal is available. Owners and admins only.

A workspace's billing state, evaluated from its record and the clock. trialing and active are a running Stripe subscription; past_due is a failed payment Stripe is still retrying (nothing is refused); grace is a legacy Free workspace (or an operator extension) inside its grace period; legacy_free is a Free workspace whose grace has not started; comped is an operator comp; blocked and canceled refuse new connections (402 billing_required) while live domains keep working. A new workspace (blocked, reason setup_required) is refused only once its first domain is connected: see first_domain_free.