← Volver al índice de esquemas
ListPublicPlansResponse
Respuesta de `GET /v1/plans/public`. Lista todos los planes activos del catálogo público (visitor-scope), con sus precios y features.
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 del recurso, fijo para esta operación. Forma parte de la identidad del recurso en la envoltura JSON:API. Siempre `plan`. |
id* | string | Slug del plan. |
attributes* | object | Atributos del recurso: los datos propiamente dichos, separados de su identidad. |
slug* | string | Identificador legible del plan (slug), estable y único; el mismo valor que `id`. |
name* | string | Nombre visible del plan para mostrar en la interfaz. |
billing_model* | string | Modelo de cobro del plan — `free` (sin costo), `tiered` (escalones fijos), `metered` (por uso) o `hybrid` (base + uso). |
monthly_validation_limit | integer | null | Tope mensual de verificaciones permitidas por el plan; `null` significa sin tope. |
included_validations | integer | null | Verificaciones incluidas sin costo adicional dentro de la cuota base; `null` cuando no aplica. |
trial_days | integer | null | Duración del periodo de prueba gratuita en días; `null` o `0` cuando el plan no ofrece prueba. |
is_default | boolean | Indica si 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 del plan, uno por combinación de periodicidad y moneda. |
features* | array | Features incluidas en el plan, en el orden en que se muestran. |
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