PlanPriceResource
JSON:API resource for an active plan price.
ExtendsJsonApiResourceBase
Properties
| Field | Type | Description |
|---|---|---|
type* | string | JSON:API resource type. Always `plan_price`. |
id* | string | Composite identifier `<currency>_<interval>_<kind>` (e.g. `MXN_month_base`). |
attributes* | object | Public plan-price attributes: currency, interval, kind, unit amount, and tax treatment. |
currency* | string | Price currency — `MXN`: Mexican pesos; `USD`: US dollars. |
billing_interval* | string | Billing cadence — `month`: Monthly; `year`: Yearly. |
kind* | string | Price kind — `base`: Flat cycle fee; `metered_overage`: Per-unit charge above the units included in the plan. |
unit_amount* | integer | null | Amount in the currency's minor unit. `null` when Stripe calculates a tiered price at billing time and it cannot be shown as a single amount. |
tax_behavior* | string | Tax treatment in `unit_amount` — `inclusive`: Already included; `exclusive`: Added to the charge. |
Used in operations
GET /v1/plans/{slug}/prices