cancelSubscription
Cancela una suscripción. 🔐 Este método requiere autorización.
Descripción
Este método cancela la suscripción del usuario actual identificada por su marcador. Devuelve una Promesa que se resuelve en true si la suscripción fue cancelada, o un objeto IError si hubo un problema.
⚠️ Con la configuración predeterminada
errors.isShell: true, una solicitud rechazada es devuelta en lugar de lanzada: este método se resuelve en un objetoIError, nunca enfalse. Verificaresult === true- un objeto de error es verdadero, por lo queif (result)trataría un fallo como éxito.
Suscripciones.cancelSubscription(
body*);
Esquema de parámetros
Esquema
body(requerido): ICancelSubscription
Cuerpo de la suscripción
ejemplo:
{ marker: "premium" }
body.marker(requerido): string
Marcador de la suscripción.
ejemplo: "premium"
Ejemplos
Ejemplo mínimo
const response = await Subscriptions.cancelSubscription({ marker: 'premium' });
Ejemplo de respuesta
{
"statusCode": 404,
"timestamp": "2026-08-14T13:04:36.941Z",
"message": "No subscription found"
}
Esquema de respuesta
Details
Esquema: boolean
boolean: booleanDevuelve true si la suscripción fue cancelada.
ejemplo: true