Cancelación de Cuota por Número de Factura
Descripción
Cancela una o más cuotas programadas en el marco de una suscripción, identificándolas por el número de factura indicado en la planilla de subida. Las cuotas quedan en estado cancelado (no se intentarán cobrar), pero la suscripción sigue activa mientras existan otras cuotas pendientes.
Este endpoint es exclusivo para comercios que utilicen la modalidad de montos dinámicos (recurrentPaymentType: "DYNAMIC"). No tiene efecto para suscripciones con cuotas pre-programadas.
Caso de uso habitual: el cliente abonó su(s) cuota(s) a través de otro medio de pago.
URL
POST /api/subscriptions/cancel-by-invoice
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 (ej: número de cédula, de socio, código de operación). |
customIdentifier2 |
Requerido si no se indica customIdentifier |
Segundo identificador personalizado del comercio (ej: número de contrato, número de abono). |
invoiceNumber |
Requerido | Número de la factura que se desea cancelar, tal cual fue indicada en la planilla de subida. |
Ejemplo
{
"customIdentifier": "11",
"customIdentifier2": "22",
"invoiceNumber": "001-003"
}
Respuesta
Respuesta Exitosa
| Campo | Descripción |
|---|---|
customIdentifier |
Identificador único de la suscripción o del cliente. |
customIdentifier2 |
Segundo identificador personalizado. |
invoiceNumber |
Número de factura que se solicitó cancelar. |
status |
"OK" o "Error", según el resultado. |
{
"customIdentifier": "123456654321",
"invoiceNumber": "001-001-000001",
"status": "OK"
}
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. |
Notas
- Este endpoint aplica exclusivamente a suscripciones de tipo
DYNAMIC(montos variables por número de factura). - Se requiere al menos uno de los dos identificadores (
customIdentifierocustomIdentifier2).