Saltar al contenido principal
POST
Cancelar plan
La cancelación en cascada es síncrona e inmediataCancelar un plan cancela de inmediato todas las suscripciones que tiene, no hay forma de cancelar el plan sin cancelar también a sus suscriptores. Revisa affected_subscriptions en la respuesta para saber cuántas se vieron afectadas.Volver a cancelar un plan que ya está en estado CANCELED es seguro y vuelve a ejecutar la cascada: devuelve 200 de nuevo, no un error. Esto es deliberado: es la vía de recuperación si una cascada anterior no logró cancelar algunas suscripciones, así que reintenta la llamada de cancelación si no estás seguro de que se completó por completo. INVALID_STATE (400) se reserva para un estado del plan distinto de ACTIVE/CANCELED, algo que hoy no puede ocurrir, ya que esos son los únicos dos estados de un plan.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Encabezados

X-Account-Code
string
requerido

El account_id que se encuentra en tu Yuno Dashboard (UUID). Obligatorio: si lo omites, se devuelve 400 BAD_REQUEST ("Invalid x-account-code header.").

Parámetros de ruta

plan_id
string
requerido

El identificador único del plan.

Cuerpo

application/json
status
enum<string>
requerido
Opciones disponibles:
CANCELED

Respuesta

200

id
string
status
string
affected_subscriptions
integer

El número de suscripciones que se cancelaron en cascada junto con el plan.