Sign in

v1

latestOpenAPI 3.1.02026-07-245178279.0 KB
Suscripciones

Cancelar una suscripción

Este endpoint permite cancelar una suscripción específica utilizando su subscription_id. La suscripción pasa a un estado de canceledy puede especificarse si será al final del mes de facturación o al final del ciclo de renovación (por ejemplo, una suscripción mensual que tiene un tiempo de un año de renovaciones). Al cumplirse ese tiempo, la suscripción pasa al estadoexpired` Reglas de negocio: - La suscripción debe estar activa. - Al merchant se le dará la opción de poder cancelar la subscripción en el proximo ciclo de renovación o al finalizar el contrato de subcripción.

post/api/v1/merchants/subscriptions/{subscription_id}/cancel

Path parameters

subscription_idstring required
Example:97dd4a78-8fa2-4002-9ab0-b329dbf16acd

ID único de la suscripción que se desea cancelar.

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

Request body

end_time'bill_date' | 'term_end'

Indica cuándo debe finalizar la suscripción.

Example request

{
  "end_time": "bill_date"
}

Response

Respuesta exitosa.

activated_atstring date-time

Fecha de activación.

auto_renewboolean

Indica si la suscripción se renueva automáticamente.

canceled_atstring date-time

Fecha de cancelación.

created_atstring date-time

Fecha y hora de creación.

currencystring

Moneda de la suscripción.

current_period_ends_atstring date-time

Fin del periodo actual.

current_period_started_atstring date-time

Inicio del periodo actual.

expires_atstring date-time

Fecha de expiración.

plan_codestring

Código del plan asociado.

remaining_billing_cyclesinteger

Ciclos de facturación restantes.

statusstring

Estado inicial de la suscripción.

subscription_idstring uuid

ID único de la suscripción creada.

total_billing_cyclesinteger

Número total de ciclos de facturación.

updated_atstring date-time

Fecha de última actualización.

Example response

{
  "activated_at": "2024-12-01T13:00:00Z",
  "auto_renew": true,
  "canceled_at": "2024-12-01T13:00:00Z",
  "created_at": "2024-12-01T13:00:00Z",
  "currency": "USD",
  "current_period_ends_at": "2024-12-01T13:00:00Z",
  "current_period_started_at": "2024-12-01T13:00:00Z",
  "expires_at": "2024-12-01T13:00:00Z",
  "payer_info": {
    "email": "juan.perez@deuna.com",
    "user_id": "isoososos"
  },
  "plan_code": "plan_basico",
  "remaining_billing_cycles": 1,
  "status": "active",
  "subscription_id": "97dd4a78-8fa2-4002-9ab0-b329dbf16acd",
  "total_billing_cycles": 12,
  "updated_at": "2024-12-01T13:00:00Z"
}