← Volver al índice de esquemas
PublicPlanResource
Un plan tal como se publica: lo que incluye y lo que cuesta, sin nada de la administración interna.
ExtiendeJsonApiResourceBase
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
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. |
Usado en operaciones
GET /v1/plans/public