Introduction
Le module Subscriptions permet de mettre en place dans un projet des paiements récurrents des utilisateurs pour un ensemble fixe de produits. Une souscription se compose d'un ensemble de produits et d'une période. Tous les N jours, l'utilisateur est débité, automatiquement (ou manuellement), d'un montant égal à la somme des prix des produits qu'elle contient.
Le module comporte deux parties principales :
- Le module "Subscriptions" dans le menu de gauche : le catalogue de toutes les souscriptions du projet. Vous y créez, modifiez et supprimez les souscriptions, et configurez leur compte de paiement, leur période et les produits qui les composent. Pour en savoir plus, consultez la section sur les paramètres des souscriptions (s'ouvre dans un nouvel onglet).
- L'onglet "Subscriptions" dans la fiche utilisateur : la liste des souscriptions d'un utilisateur donné, avec leurs statuts, leurs dates d'expiration et les actions manuelles (pour les souscriptions de type
custom). Pour en savoir plus, consultez la section sur les souscriptions de l'utilisateur (s'ouvre dans un nouvel onglet).
Côté application cliente, les souscriptions se gèrent via l'API. Pour en savoir plus, consultez la section sur l'API des souscriptions (s'ouvre dans un nouvel onglet).
Fonctionnement d'une souscription
Lorsque vous créez une souscription dans le panneau d'administration, vous choisissez :
- Le compte de paiement : il détermine la manière dont le paiement est effectué. Les types de comptes sont décrits dans la section sur les comptes de paiement (s'ouvre dans un nouvel onglet).
- La période en jours : l'intervalle au bout duquel l'utilisateur doit payer pour renouveler la souscription.
- La liste des produits inclus dans la souscription : la somme de leurs prix actuels donne le coût total de la souscription.
Lorsqu'un utilisateur souscrit via l'API, le système :
- Crée un enregistrement de souscription pour l'utilisateur.
- Renvoie un lien de paiement (pour
stripeetmidtrans) ou, pour le typecustom, active immédiatement la souscription. - À la fin de la période, prélève automatiquement le paiement suivant (
stripe,midtrans) ou attend un renouvellement manuel (custom).
Comptes de paiement pris en charge
Vous pouvez connecter à une souscription l'un des types de comptes de paiement suivants :
- Stripe : prélèvements périodiques automatiques via Stripe. Une fois la souscription créée, l'API renvoie un lien pour le premier paiement.
- Midtrans : prélèvements périodiques automatiques via Midtrans. Comme pour Stripe, l'API renvoie un lien de paiement.
- Custom : souscription manuelle. Aucun prélèvement n'est effectué automatiquement ; l'administrateur renouvelle et annule la souscription depuis la fiche utilisateur.
Le type de compte de paiement détermine les actions disponibles sur la souscription et la possibilité de l'annuler via l'API.
Les souscriptions custom ne peuvent être annulées que depuis le panneau d'administration, dans la section de l'utilisateur.
Évolution du coût
Le coût d'une souscription correspond à la somme des prix des produits qui la composent. Si vous modifiez le prix de l'un de ces produits, les souscriptions actives recalculent automatiquement leur coût, et le nouveau montant s'applique à partir de la période de prélèvement suivante.
La période en cours est toujours facturée au prix en vigueur à son début. Vous pouvez ainsi modifier la composition et les prix des produits sans affecter les périodes déjà payées par l'utilisateur.