Listar planes
GET /api/subscriptions/plans
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista los planes de suscripción, del más reciente al más antiguo.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor). El vendedor los necesita para suscribir clientes.
Formato de respuesta: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}.
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
status |
0 / 1 | No | 1 activos, 0 inactivos. Sin el parámetro, todos. |
cat_period_id |
integer | No | Solo los de esa periodicidad. |
search |
string | No | Coincidencia parcial en el nombre o la descripción. |
limit / cursor |
integer / string | No | Paginación por cursor. |
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
Campos de cada plan:
| Campo | Tipo | Descripción |
|---|---|---|
id |
integer | Id del plan. |
name / description |
string | Nombre y descripción. |
status |
boolean | true activo: se puede suscribir clientes. false inactivo. |
cat_period_id / period |
integer / objeto | Periodicidad del cobro {id, code, name}. |
unlimited |
boolean | true = sin fecha de fin: se cobra cada periodo hasta cancelar. |
quantity_period |
integer o null | Cantidad de cobros (periodos) del plan; null si es ilimitado. |
trial_days |
integer o null | Días de prueba gratis antes del primer cobro. |
total_taxed / total_exonerated / total_unaffected / total_igv / total_value / total |
number | Totales por periodo calculados por el servidor. |
items |
array | Productos del plan con sus importes calculados (unit_value sin IGV, total con IGV) y apply_in_period. |
subscriptions_count / can_delete |
integer / boolean | Suscripciones que usan el plan; con alguna, can_delete es false. |
checkout_url |
string | Página pública del plan para que el cliente se suscriba y pague en línea. |
Errores:
422sistatusno es 0/1.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
status |
query | no | 1 |
1 activos, 0 inactivos. |
cat_period_id |
query | no | 1 |
Periodicidad. |
search |
query | no | Busca en nombre y descripción. | |
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Listado
{
"success": true,
"data": [
{
"id": 3,
"name": "Plan Mensual Gold",
"description": "Acceso ilimitado al gimnasio y clases grupales",
"status": true,
"cat_period_id": 1,
"period": {
"id": 1,
"code": "M",
"name": "Mensual"
},
"unlimited": false,
"quantity_period": 12,
"trial_days": 7,
"currency_type_id": "PEN",
"total_taxed": 100.0,
"total_exonerated": 0.0,
"total_unaffected": 0.0,
"total_igv": 18.0,
"total_value": 100.0,
"total": 118.0,
"items": [
{
"id": 77,
"item_id": 845,
"description": "MEMBRESÍA GIMNASIO",
"internal_id": "MEM-001",
"quantity": 1.0,
"unit_price": 118.0,
"unit_value": 100.0,
"affectation_igv_type_id": "10",
"total_value": 100.0,
"total_igv": 18.0,
"total": 118.0,
"apply_in_period": "all"
}
],
"subscriptions_count": 24,
"can_delete": false,
"checkout_url": "https://empresa.dominio/full_suscription/plans/3"
}
],
"pagination": {
"next_cursor": null,
"has_more": false
}
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.