cancelSubscription

Annuler un abonnement. 🔐 Cette méthode nécessite l'autorisation.

Description

Cette méthode annule l'abonnement de l'utilisateur actuel identifié par son marqueur. Elle renvoie une promesse qui se résout en true si l'abonnement a été annulé, ou un objet IError s'il y a eu un problème.

⚠️ Avec le paramètre par défaut errors.isShell: true, une requête rejetée est retournée plutôt que lancée : cette méthode se résout en un objet IError, jamais en false. Vérifiez result === true - un objet d'erreur est considéré comme vrai, donc if (result) traiterait un échec comme un succès.

Abonnements.cancelSubscription(

body*

);

Schéma des paramètres

Schéma

body(obligatoire): ICancelSubscription
Corps de l'abonnement
exemple:

{ marker: "premium" }

body.marker(obligatoire): string
Marqueur de l'abonnement.
exemple: "premium"

Exemples

Exemple minimal

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

Exemple de réponse

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

Schéma de réponse

Details

Schéma : boolean

boolean: boolean
Renvoie true si l'abonnement a été annulé.
exemple: true

---