Skip to content

Consultar Cuotas de Suscripción

Descripción

Retorna las cuotas pendientes de suscripciones activas para la combinación de identificadores proporcionados.

URL

GET /api/subscriptions/installments

Autenticación

Header Api-Token con token UUID proporcionado por MetrePay.

Petición

Headers

Header Valor
Api-Token Token UUID del comercio
Content-Type application/json

Cuerpo

Campo Condición Descripción
customIdentifier Requerido si no se indica customIdentifier2 Identificador único de la suscripción o del cliente.
customIdentifier2 Requerido si no se indica customIdentifier Segundo identificador personalizado del comercio.

Ejemplo

{
  "customIdentifier": "123-4"
}

Respuesta

Respuesta Exitosa

Se devuelve un array de cuotas (installments) con los detalles de las cuotas pendientes.

Campo Tipo Descripción
id Texto Identificador único de la cuota (installment).
amount Numérico (2 decimales) Monto de la cuota.
payment_date Texto (yyyy-MM-dd) Fecha programada de la cuota.
{
  "installments": [
    {
      "id": "123456",
      "amount": 75000.00,
      "payment_date": "2025-07-01"
    },
    {
      "id": "123457",
      "amount": 75000.00,
      "payment_date": "2025-08-01"
    },
    {
      "id": "123458",
      "amount": 75000.00,
      "payment_date": "2025-09-01"
    }
  ]
}

Respuestas de Error

Código HTTP Descripción
400 Petición inválida (campos requeridos faltantes o formato incorrecto).
401 Token de autenticación inválido o ausente.
404 No se encontró suscripción activa para los identificadores proporcionados.

Notas

  • Solo se retornan cuotas pendientes de suscripciones activas.
  • Se requiere al menos uno de los dos identificadores (customIdentifier o customIdentifier2).
  • Los datos retornados corresponden a lo visible en la interfaz web del portal.