Cancelación de Cuota por Monto

Descripción

Cancela una o más cuotas programadas en el marco de una suscripción, identificándolas por su monto. Las cuotas quedan en estado cancelado (no se intentarán cobrar), pero la suscripción sigue activa mientras existan otras cuotas pendientes.

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-amount

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).
`amount`	Requerido	Monto de la cuota a cancelar.
`quantity`	Requerido	Cantidad de cuotas del mismo monto a cancelar.

Ejemplo

{
  "customIdentifier": "11",
  "amount": 10000,
  "quantity": 1
}

Respuesta

Respuesta Exitosa

Campo	Descripción
`customIdentifier`	Identificador único de la suscripción o del cliente.
`customIdentifier2`	Segundo identificador personalizado.
`amount`	Monto de la cuota que se solicitó cancelar.
`quantity`	Cantidad de cuotas que se solicitó cancelar.
`status`	`"OK"` o `"Error"`, según el resultado.
`quantityCancelled`	Cantidad de cuotas canceladas efectivamente.

{
  "customIdentifier": "123456654321",
  "ammount": 4000,
  "quantity": 2,
  "status": "OK",
  "quantityCancelled": 1
}

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

Se requiere al menos uno de los dos identificadores (customIdentifier o customIdentifier2). Si se proporcionan ambos, se utilizan en conjunto para la búsqueda.
El campo quantityCancelled puede ser menor a quantity si no se encontraron suficientes cuotas pendientes con el monto indicado.