PublicPlanResource
Public-catalog plan with its active prices and features.
ExtendsJsonApiResourceBase
Properties
| Field | Type | Description |
|---|---|---|
type* | string | JSON:API resource type. Always `plan`. |
id* | string | Unique, human-readable plan identifier. |
attributes* | object | The resource's own data, kept apart from its identity. |
slug* | string | Unique, human-readable plan identifier. It has the same value as `id`. |
name* | string | Plan name shown in the interfaces. |
billing_model* | string | Plan billing model — `free`: No charge; `tiered`: Flat fee; `metered`: Usage-based charge; `hybrid`: Flat fee plus usage. |
monthly_validation_limit* | integer | Validation cap per subscription cycle. `0` allows no validations. |
included_validations* | integer | null | Validations included in the base quota before overage charges. `null` when the plan has no base quota. |
trial_days* | integer | null | Free trial days. `null` or `0` when the plan offers no free trial. |
is_default* | boolean | `true` when 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 | Active plan prices, one per currency, billing interval, and pricing-kind combination. |
features* | array | Active bilingual plan features, ordered by `sort_order`. |
Used in operations
GET /v1/plans/public