Listar suscripciones
GET /api/subscriptions
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista las suscripciones, de la más reciente a la más antigua.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor). Los registros de suscripciones son de toda la empresa: un vendedor ve y gestiona los mismos que el administrador.
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 |
|---|---|---|---|
customer_id |
integer | No | Solo las de ese suscriptor. |
plan_id |
integer | No | Solo las de ese plan. |
status |
string | No | authorized, paused, cancelled o finished. |
search |
string | No | Nombre o número de documento del suscriptor. |
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 suscripción:
| Campo | Tipo | Descripción |
|---|---|---|
id |
integer | Id de la suscripción. |
status / status_description |
string | authorized Activa, paused Pausada, cancelled Cancelada, finished Finalizada. |
plan_id / plan_name |
integer / string | Plan. |
customer_id / customer |
integer / objeto | Suscriptor {id, name, number, identity_document_type_id, email}. |
cat_period_id / period_name / unlimited / quantity_period |
Periodicidad y cantidad de cobros copiadas del plan. | |
orders_created |
integer | Órdenes de cobro creadas hasta ahora. |
start_date / end_date |
fecha | Primer cobro y último cobro (end_date null si es ilimitado). |
trial_start_date / trial_days |
fecha / integer | Prueba gratis. |
total / currency_type_id |
number / string | Monto de cada periodo (copiado del plan al suscribirse). |
Errores:
422sistatusno es un estado válido.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
customer_id |
query | no | 1520 |
Suscriptor. |
plan_id |
query | no | 3 |
Plan. |
status |
query | sí | authorized |
Estado. |
search |
query | no | Nombre o documento del suscriptor. | |
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": 48,
"status": "authorized",
"status_description": "Activa",
"plan_id": 3,
"plan_name": "Plan Mensual Gold",
"customer_id": 1520,
"customer": {
"id": 1520,
"name": "MARÍA FERNANDA QUISPE ROJAS",
"number": "45879632",
"identity_document_type_id": "1",
"email": "maria.quispe@correo.pe"
},
"cat_period_id": 1,
"period_name": "Mensual",
"unlimited": false,
"quantity_period": 12,
"orders_created": 1,
"start_date": "2026-11-14",
"end_date": "2027-10-14",
"trial_start_date": "2026-11-07",
"trial_days": 7,
"currency_type_id": "PEN",
"total": 118.0,
"created_at": "2026-11-07 10:15:32"
}
],
"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.