← Volver al índice de esquemas
ListPublicPlansResponse
Respuesta de `GET /v1/plans/public` con los planes activos del catálogo público, sus precios y características.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | array | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type* | string | Tipo de recurso JSON:API. Siempre `plan`. |
id* | string | Identificador único y legible del plan. |
attributes* | object | Datos del recurso, separados de su identidad. |
slug* | string | Identificador único y legible del plan. Tiene el mismo valor que `id`. |
name* | string | Nombre del plan que muestran las interfaces. |
billing_model* | string | Modelo de facturación del plan — `free`: Sin cobro; `tiered`: Cuota fija; `metered`: Cobro por consumo; `hybrid`: Cuota fija más consumo. |
monthly_validation_limit* | integer | Tope de validaciones por ciclo de la suscripción. `0` no permite validaciones. |
included_validations* | integer | null | Validaciones incluidas en la cuota base antes del cobro por excedentes. `null` cuando el plan no tiene cuota base. |
trial_days* | integer | null | Días de prueba gratuita. `null` o `0` cuando el plan no ofrece prueba gratuita. |
is_default* | boolean | `true` cuando es el plan asignado por defecto a las cuentas nuevas. |
sort_order* | integer | Posición de ordenamiento para listar el plan dentro del catálogo (ascendente). |
prices* | array | Precios activos del plan, uno por combinación de moneda, intervalo de facturación y modalidad. |
features* | array | Características bilingües activas del plan, ordenadas por `sort_order`. |
meta | object | Metadatos 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. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor 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* | string | Siempre `UTC`: La zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601`: Sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/plans/public