ListPlanPricesResponse
Response of `GET /v1/plans/{slug}/prices`. Lists the plan's active prices plus a mini summary of the plan in `meta.plan` to spare a round-trip to `/v1/plans/{slug}`.
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_price`. |
id* | string | Composite key `<currency>_<interval>_<kind>` (e.g. `MXN_month_base`). |
attributes* | object | Stripe 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). |
currency | string | Price currency. `MXN` is Mexican pesos and `USD`, US dollars. |
billing_interval | string | Billing cadence. `month` bills monthly; `year`, yearly. |
kind | string | Price kind. `base` = flat cycle fee; `metered_overage` = per-unit charge over the included amount. |
unit_amount | integer | null | Amount 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_behavior | string | How tax is treated in `unit_amount`. `inclusive` = already included; `exclusive` = added on top at checkout. |
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/{slug}/prices