BillingSubscriptionQuotaMeta
Quota summary for the active cycle. Returned at `meta.quota` by `GET /v1/billing/subscription`.
Properties
| Field | Type | Description |
|---|---|---|
plan_slug | string | Unique, human-readable plan identifier. It matches `data.attributes.plan_slug`. |
plan_name | string | Plan name shown in the interfaces. |
billing_model | string | Plan billing model. `free`: No charge; `tiered`: Flat fee; `metered`: Charged by usage; `hybrid`: Flat fee plus usage. |
source | string | Subscription source — `stripe`: Payment through Stripe; `admin_granted`: Admin grant; `system_default`: Plan assigned by the system. |
overage_enabled | boolean | `true` when the user has opted into overage billing on a `hybrid` plan. When so, `effective_limit` jumps from `included_validations` to `monthly_validation_limit`. |
overage_available | boolean | `true` when the plan is `hybrid` and overage billing is not active yet: the user can turn it on. |
monthly_limit_override | integer | null | Cycle limit set by an administrator for this subscription. When present, it overrides the plan's. `null` without an override. |
included_validations | integer | null | Validations included in the base quota before overage charges. `null` when the plan has no base quota. |
monthly_validation_limit | integer | Validation cap per subscription cycle. `0` allows no validations. On `hybrid` plans, it is the hard cap when `overage_enabled` is `true`; when it is `false`, `effective_limit` uses `included_validations`. On other models, it is the effective limit unless an admin override applies. |
used | integer | Validations consumed in the current cycle. |
limit | integer | Effective validation limit for the current cycle. Same value as `data.attributes.effective_limit`, except with `quota_kind=trial`: then it is the trial allowance. |
remaining | integer | Validations available in the current cycle (`max(0, limit - used)`). |
resets_at | string (date-time) | ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response. |
quota_kind | string | Where this quota comes from: `cycle` (the usual subscription cycle) or `trial` (an unclaimed account's initial trial allowance). Additive — a client that ignores it keeps working the same way. |
renews | boolean | `true` when this quota replenishes at the next cycle. `false` for `quota_kind=trial`: `resets_at` is the technical period's end, not a promise of more units. |
Used in operations
GET /v1/billing/subscription