ListPublicPlansResponse
Response of `GET /v1/plans/public`. Lists every active plan in the public catalog (visitor scope), including prices and features.
Properties
| Field | Type | Description |
|---|---|---|
data | array | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
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. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC` — the canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601` — explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/plans/public