Saltar al contenido
Facturador

Listar órdenes de cobro

GET /api/subscriptions/orders

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

Lista las órdenes de cobro de las suscripciones (una por periodo), 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
status string No Uno o varios separados por coma: pending, paid, rejected, expired, canceled. P. ej. pending,rejected,expired = por cobrar.
customer_id integer No Suscriptor.
plan_id integer No Plan.
subscription_id integer No Suscripción.
date_field string No Fecha a la que aplican date_from/date_to: issue creación (por defecto), due vencimiento, payment pago.
date_from / date_to fecha Y-m-d No Rango de fechas (inclusive).
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 orden:

Campo Tipo Descripción
id / number integer / string Id y número correlativo de la orden (SO-0311).
status / status_description string pending, paid, rejected, expired, canceled.
amount / currency_type_id number / string Monto a cobrar.
date_of_issue / date_of_due / date_of_payment fecha Creación, vencimiento y pago (con hora).
subscription_id / plan_id / plan_name Suscripción y plan.
customer_id / customer_name / customer_number Suscriptor.
count_notification / date_notification integer / fecha Avisos de cobro enviados y el último.
count_rejected_payments integer Veces que se rechazó el pago.
payment_url string Enlace de pago en línea para el cliente.
document objeto o null Comprobante emitido {id, document_type_id, number_full, date_of_issue, total, state_type_id, download_pdf}.

Errores:

  • 422 si status tiene un valor no válido, o las fechas otro formato o date_to es anterior a date_from.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
status query sí pending,rejected,expired Estados separados por coma.
customer_id query no 1520 Suscriptor.
plan_id query no 3 Plan.
subscription_id query no 48 Suscripción.
date_field query no due issue, due o payment.
date_from query no 2026-12-01 Desde.
date_to query no 2026-12-31 Hasta.
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": 311,
      "number": "SO-0311",
      "status": "pending",
      "status_description": "Pendiente",
      "amount": 118.0,
      "currency_type_id": "PEN",
      "date_of_issue": "2026-12-14",
      "date_of_due": "2026-12-14",
      "date_of_payment": null,
      "subscription_id": 48,
      "plan_id": 3,
      "plan_name": "Plan Mensual Gold",
      "customer_id": 1520,
      "customer_name": "MARÍA FERNANDA QUISPE ROJAS",
      "customer_number": "45879632",
      "count_notification": 1,
      "date_notification": "2026-12-14 09:00:04",
      "count_rejected_payments": 0,
      "payment_url": "https://empresa.dominio/full-suscription/pending-payments/order/482913",
      "document": null
    },
    {
      "id": 311,
      "number": "SO-0311",
      "status": "rejected",
      "status_description": "Rechazado",
      "amount": 118.0,
      "currency_type_id": "PEN",
      "date_of_issue": "2026-12-14",
      "date_of_due": "2026-12-14",
      "date_of_payment": null,
      "subscription_id": 48,
      "plan_id": 3,
      "plan_name": "Plan Mensual Gold",
      "customer_id": 1520,
      "customer_name": "MARÍA FERNANDA QUISPE ROJAS",
      "customer_number": "45879632",
      "count_notification": 1,
      "date_notification": "2026-12-14 09:00:04",
      "count_rejected_payments": 1,
      "payment_url": "https://empresa.dominio/full-suscription/pending-payments/order/482913",
      "document": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}

422 — Estado inválido

{
  "success": false,
  "message": {
    "status": [
      "Estado no válido: pagado. Usa pending, paid, rejected, expired, canceled."
    ]
  }
}

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.