Skip to content

Cancelación de Suscripción Completa

Descripción

Cancela todas las cuotas pendientes de una suscripción y la da por finalizada.

Caso de uso habitual: el cliente se da de baja del servicio.

URL

POST /api/subscriptions/cancel-all

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).

Ejemplo

{
  "customIdentifier": "11",
  "customIdentifier2": "22"
}

Respuesta

Respuesta Exitosa

Campo Descripción
customIdentifier Identificador único de la suscripción o del cliente.
customIdentifier2 Segundo identificador personalizado.
status "OK" o "Error", según el resultado.
{
  "customIdentifier": "123456654321",
  "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

  • Se requiere al menos uno de los dos identificadores (customIdentifier o customIdentifier2).
  • Esta operación finaliza la suscripción por completo. Todas las cuotas pendientes pasan a estado cancelado.