← Back to schema index

PublicPlanResource

Public-catalog plan with its active prices and features.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringJSON:API resource type. Always `plan`.
id*stringUnique, human-readable plan identifier.
attributes*objectThe resource's own data, kept apart from its identity.
slug*stringUnique, human-readable plan identifier. It has the same value as `id`.
name*stringPlan name shown in the interfaces.
billing_model*stringPlan billing model — `free`: No charge; `tiered`: Flat fee; `metered`: Usage-based charge; `hybrid`: Flat fee plus usage.
monthly_validation_limit*integerValidation cap per subscription cycle. `0` allows no validations.
included_validations*integer | nullValidations included in the base quota before overage charges. `null` when the plan has no base quota.
trial_days*integer | nullFree 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*integerSort position used to order the plan within the catalog (ascending).
prices*arrayActive plan prices, one per currency, billing interval, and pricing-kind combination.
features*arrayActive bilingual plan features, ordered by `sort_order`.

Used in operations

  • GET /v1/plans/public

Referenced by schemas