← Back to schema index

PublicPlanResource

A plan as published: what it includes and what it costs, with none of the internal administration.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringResource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `plan`.
id*stringPlan slug.
attributes*objectThe resource's own data, kept apart from its identity.
slug*stringHuman-readable plan identifier (slug), stable and unique; same value as `id`.
name*stringDisplay name of the plan, shown in the UI.
billing_model*stringPlan billing model — `free` (no cost), `tiered` (fixed tiers), `metered` (usage-based) or `hybrid` (base + usage).
monthly_validation_limitinteger | nullMonthly cap on validations allowed by the plan; `null` means uncapped.
included_validationsinteger | nullValidations included at no extra cost within the base quota; `null` when not applicable.
trial_daysinteger | nullFree-trial length in days; `null` or `0` when the plan has no trial.
is_defaultbooleanWhether this is the default plan assigned to new accounts.
sort_orderintegerSort position used to order the plan within the catalog (ascending).
prices*arrayPlan prices, one per billing-period and currency combination.
features*arrayFeatures included in the plan, in display order.

Used in operations

  • GET /v1/plans/public

Referenced by schemas