cancelSubscription

Cancele uma assinatura. 🔐 Este método requer autorização.

Descrição

Este método cancela a assinatura do usuário atual identificada pelo seu marcador. Ele retorna uma Promise que resolve para true se a assinatura foi cancelada, ou um objeto IError se houve um problema.

⚠️ Com a configuração padrão errors.isShell: true, uma solicitação rejeitada é retornada em vez de lançada: este método resolve para um objeto IError, nunca para false. Verifique result === true - um objeto de erro é verdadeiro, então if (result) trataria uma falha como sucesso.

Assinaturas.cancelSubscription(

body*

);

Esquema de parâmetros

Esquema

body(obrigatório): ICancelSubscription
Corpo da assinatura
exemplo:

{ marker: "premium" }

body.marker(obrigatório): string
Marcador da assinatura.
exemplo: "premium"

Exemplos

Exemplo mínimo

const response = await Subscriptions.cancelSubscription({ marker: 'premium' });

Exemplo de resposta

{
  "statusCode": 404,
  "timestamp": "2026-08-14T13:04:36.941Z",
  "message": "No subscription found"
}

Esquema de resposta

Details

Esquema: boolean

boolean: boolean
Retorna true se a assinatura foi cancelada.
exemplo: true

---