Saltar al contenido
Facturador

Ver suscripción

GET /api/subscriptions/{subscription_id}

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Devuelve la suscripción con el resumen de sus órdenes y la fecha en que se creará la próxima.

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: estándar {success, data, message?} (registro único).

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
subscription_id integer Sí Id de la 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).

Además: orders_summary {total, pending, paid} (pending incluye rechazadas y vencidas) y next_order_date (fecha en que el sistema creará la siguiente orden, o null si ya no generará más).

Errores:

  • 404 si el registro no existe.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
subscription_id ruta sí 48

Respuestas

200 — Suscripción

{
  "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",
    "orders_summary": {
      "total": 1,
      "pending": 1,
      "paid": 0
    },
    "next_order_date": "2026-12-11"
  }
}

404 — No existe

{
  "success": false,
  "message": "Registro no encontrado."
}

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.