PublicPlanResource
A plan as published: what it includes and what it costs, with none of the internal administration.
ExtendsJsonApiResourceBase
Properties
| Field | Type | Description |
|---|---|---|
type* | string | Resource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `plan`. |
id* | string | Plan slug. |
attributes* | object | The resource's own data, kept apart from its identity. |
slug* | string | Human-readable plan identifier (slug), stable and unique; same value as `id`. |
name* | string | Display name of the plan, shown in the UI. |
billing_model* | string | Plan billing model — `free` (no cost), `tiered` (fixed tiers), `metered` (usage-based) or `hybrid` (base + usage). |
monthly_validation_limit | integer | null | Monthly cap on validations allowed by the plan; `null` means uncapped. |
included_validations | integer | null | Validations included at no extra cost within the base quota; `null` when not applicable. |
trial_days | integer | null | Free-trial length in days; `null` or `0` when the plan has no trial. |
is_default | boolean | Whether this is the default plan assigned to new accounts. |
sort_order | integer | Sort position used to order the plan within the catalog (ascending). |
prices* | array | Plan prices, one per billing-period and currency combination. |
features* | array | Features included in the plan, in display order. |
Used in operations
GET /v1/plans/public