← Back to schema index

ListPlanPricesResponse

Response from `GET /v1/plans/{slug}/prices` with active prices and a plan summary in `meta.plan`.

Properties

FieldTypeDescription
dataarrayMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
type*stringJSON:API resource type. Always `plan_price`.
id*stringComposite identifier `<currency>_<interval>_<kind>` (e.g. `MXN_month_base`).
attributes*objectPublic plan-price attributes: currency, interval, kind, unit amount, and tax treatment.
currency*stringPrice currency — `MXN`: Mexican pesos; `USD`: US dollars.
billing_interval*stringBilling cadence — `month`: Monthly; `year`: Yearly.
kind*stringPrice kind — `base`: Flat cycle fee; `metered_overage`: Per-unit charge above the units included in the plan.
unit_amount*integer | nullAmount 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*stringTax treatment in `unit_amount` — `inclusive`: Already included; `exclusive`: Added to the charge.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.
timezone*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

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