← Back to schema index

PlanPriceResource

One plan price, with its currency, its cadence, and the Stripe price it maps to.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringResource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `plan_price`.
id*stringComposite key `<currency>_<interval>_<kind>` (e.g. `MXN_month_base`).
attributes*objectStripe price tied to a plan, surfaced to clients without revealing `stripe_price_id`. A plan may carry several prices for combinations of currency × interval × kind (`base` for the flat fee + optional `metered_overage` for metered overage).
currencystringPrice currency. `MXN` is Mexican pesos and `USD`, US dollars.
billing_intervalstringBilling cadence. `month` bills monthly; `year`, yearly.
kindstringPrice kind. `base` = flat cycle fee; `metered_overage` = per-unit charge over the included amount.
unit_amountinteger | nullAmount in minor units (cents). `null` when the price is tiered server-side in Stripe (the rate is computed at billing time and cannot be pre-displayed as a single number).
tax_behaviorstringHow tax is treated in `unit_amount`. `inclusive` = already included; `exclusive` = added on top at checkout.

Used in operations

  • GET /v1/plans/{slug}/prices

Referenced by schemas