API des abonnements

L'application cliente dispose de trois points de terminaison pour gérer les abonnements : souscrire un abonnement, l'annuler et récupérer la liste des abonnements actifs de l'utilisateur courant.

Tous les points de terminaison s'exécutent au nom de l'utilisateur authentifié. L'abonnement est toujours lié au jeton utilisé pour la requête.

Souscription

Crée un nouvel abonnement pour l'utilisateur courant sur le marqueur indiqué.

Le comportement dépend du type de compte de paiement lié à l'abonnement dans les paramètres du module (s'ouvre dans un nouvel onglet) :

• stripe, midtrans : un enregistrement d'abonnement est créé et un lien de paiement est renvoyé. L'abonnement devient actif une fois le prélèvement effectué avec succès par le fournisseur.
• custom : l'abonnement est créé et considéré comme actif immédiatement. Aucun lien de paiement n'est renvoyé ; l'administrateur enregistre le paiement manuellement depuis la fiche utilisateur (s'ouvre dans un nouvel onglet).

Annulation d'abonnement

Annule immédiatement l'abonnement actif de l'utilisateur.

Le comportement dépend du type de compte de paiement :

• stripe, midtrans : l'abonnement est annulé via l'API du fournisseur. Les prélèvements automatiques s'arrêtent et le statut de l'abonnement passe à canceled.
• custom : l'annulation via l'API n'est pas disponible. Seul l'administrateur peut annuler ces abonnements, depuis la fiche utilisateur (s'ouvre dans un nouvel onglet).

info

Toute tentative d'annuler un abonnement custom via l'API renvoie une erreur. Ce comportement est voulu : les abonnements manuels sont gérés par l'administrateur, car leurs paiements s'effectuent en dehors du système.

Récupération des abonnements actifs

Renvoie un tableau des marqueurs des abonnements actifs de l'utilisateur courant.

Un abonnement est considéré comme actif si :

• Il a été souscrit avec succès.
• Sa période en cours n'a pas encore expiré.
• Il n'a pas été annulé (canceled).

Lorsqu'un abonnement expire ou est annulé, son marqueur disparaît automatiquement de la liste. Côté client, ce point de terminaison permet de vérifier l'accès au contenu : si le marqueur de l'abonnement requis figure dans le tableau, l'accès est accordé.