← 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

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`.
id*stringSlug del plan.
attributes*objectAtributos del recurso: los datos propiamente dichos, separados de su identidad.
slug*stringIdentificador legible del plan (slug), estable y único; el mismo valor que `id`.
name*stringNombre visible del plan para mostrar en la interfaz.
billing_model*stringModelo de cobro del plan — `free` (sin costo), `tiered` (escalones fijos), `metered` (por uso) o `hybrid` (base + uso).
monthly_validation_limitinteger | nullTope mensual de verificaciones permitidas por el plan; `null` significa sin tope.
included_validationsinteger | nullVerificaciones incluidas sin costo adicional dentro de la cuota base; `null` cuando no aplica.
trial_daysinteger | nullDuración del periodo de prueba gratuita en días; `null` o `0` cuando el plan no ofrece prueba.
is_defaultbooleanIndica si es el plan asignado por defecto a las cuentas nuevas.
sort_orderintegerPosición de ordenamiento para listar el plan dentro del catálogo (ascendente).
prices*arrayPrecios del plan, uno por combinación de periodicidad y moneda.
features*arrayFeatures incluidas en el plan, en el orden en que se muestran.
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/public