Aller au contenu principal

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.

Subscriptions.cancelSubscription(

body*, body.marker*

);

Parameters schema​

Schéma

body(obligatoire): ICancelSubscription
Corps de l'abonnement. Exemple : { marker: "premium" }

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

Examples​

Exemple minimal​

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

Exemple de rĂ©ponse​

true

SchĂ©ma de rĂ©ponse​

Schéma : boolean

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