← Volver al índice de esquemas

ListPlanPricesResponse

Respuesta de `GET /v1/plans/{slug}/prices`. Lista los precios activos del plan más un mini-resumen del plan en `meta.plan` para evitar un round-trip extra a `/v1/plans/{slug}`.

Propiedades

CampoTipoDescripción
dataarrayPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
type*stringTipo del recurso, fijo para esta operación. Forma parte de la identidad del recurso en la envoltura JSON:API. Siempre `plan_price`.
id*stringLlave compuesta `<currency>_<interval>_<kind>` (ej. `MXN_month_base`).
attributes*objectPrecio Stripe asociado a un plan, expuesto al cliente sin revelar `stripe_price_id`. Cada plan puede tener varios precios para combinaciones de moneda × intervalo × tipo (`base` para tarifa fija + opcional `metered_overage` para excedente medido).
currencystringMoneda del precio. `MXN` son pesos mexicanos y `USD`, dólares estadounidenses.
billing_intervalstringCadencia de facturación. `month` cobra cada mes; `year`, cada año.
kindstringTipo de precio. `base` = cuota fija del ciclo; `metered_overage` = cargo por unidad consumida por encima del incluido.
unit_amountinteger | nullMonto en unidades mínimas (centavos). `null` cuando el precio es tiered server-side en Stripe (la tarifa se calcula al momento de facturar y no se puede pre-mostrar como un solo número).
tax_behaviorstringCómo se trata el impuesto en `unit_amount`. `inclusive` = ya incluido; `exclusive` = se agrega al cobro.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC` — la zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601` — sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

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