Aller au contenu principal

Introduction

Vendez l'accès à votre produit sous forme d'abonnement payant récurrent.

🔐 Les méthodes de ce module nécessitent une autorisation.

Plus d'informations sur l'interface utilisateur du module https://doc.oneentry.cloud/docs/category/subscriptions

🎯 Que fait ce module ?​

Le module Subscriptions vous permet de gérer des abonnements payants pour l'utilisateur actuel - créer un abonnement et recevoir une session de paiement, l'annuler, le récupérer via le Stripe Billing Portal, et lister les marqueurs d'abonnement disponibles ou actifs.

Considérez-le comme une facturation récurrente pour votre application - au lieu de commandes ponctuelles, un utilisateur s'abonne à un plan (un "marqueur" tel que premium) et est facturé automatiquement par le fournisseur de paiement.

📖 Explication Simple​

Un flux d'abonnement ressemble généralement à ceci :

  • 🧾 Plans - Vous définissez des plans d'abonnement (marqueurs) dans le panneau d'administration de OneEntry
  • 💳 S'abonner - L'utilisateur choisit un plan et est redirigé vers une session de paiement
  • 🔁 Facturation récurrente - Le fournisseur de paiement facture automatiquement l'utilisateur
  • ❌ Annuler - L'utilisateur annule et conserve l'accès jusqu'à la fin de la période
  • ♻️ Récupérer - L'utilisateur restaure un abonnement annulé via le Billing Portal

✨ Concepts Clés​

Qu'est-ce qu'un marqueur d'abonnement ?​

Un marqueur est l'identifiant textuel unique d'un plan d'abonnement (par exemple premium). Vous le passez à chaque méthode de ce module pour indiquer à OneEntry de quel plan vous parlez. Les marqueurs ne changent jamais, donc référez-vous toujours aux plans par leur marqueur dans votre code.

Session de paiement​

subscribe() retourne une session de paiement - un objet avec un paymentUrl que l'utilisateur doit ouvrir pour compléter le premier paiement. Redirigez l'utilisateur là-bas pour terminer le processus de paiement.

📋 Ce Que Vous Devez Savoir​

  • Toutes les méthodes nécessitent un utilisateur autorisé - appelez-les après que l'utilisateur se soit connecté via le module AuthProvider.
  • getAllSubscriptions() retourne tous les marqueurs disponibles, getActiveSubscriptions() retourne uniquement les marqueurs auxquels l'utilisateur actuel est abonné.
  • cancelSubscription() et recoverSubscriptions() renvoient true en cas de succès.

📊 Tableau de Référence Rapide​

MéthodeDescription
subscribe()Créer un abonnement et obtenir une session de paiement
getAllSubscriptions()Obtenir tous les marqueurs d'abonnement disponibles
getActiveSubscriptions()Obtenir les marqueurs des abonnements actifs de l'utilisateur
cancelSubscription()Annuler un abonnement
recoverSubscriptions()Récupérer un abonnement via le Billing Portal

❓ Questions Fréquemment Posées (FAQ)​

Comment créer un plan d'abonnement ?​

Les plans d'abonnement sont configurés dans le panneau d'administration de OneEntry et connectés à un compte de paiement (par exemple Stripe). Le SDK fait référence à chaque plan par son marqueur.

Que retourne subscribe() ?​

Il retourne une session de paiement avec un paymentUrl. Redirigez l'utilisateur vers cette URL pour compléter le premier paiement et activer l'abonnement.

Quelle est la différence entre annuler et récupérer ?​

cancelSubscription() arrête la facturation récurrente pour un plan. recoverSubscriptions() restaure un abonnement précédemment annulé via le Stripe Billing Portal.

🎓 Meilleures Pratiques​

  • Référez-vous toujours aux plans par marqueur, jamais par un nom d'affichage.
  • Authentifiez l'utilisateur avant d'appeler toute méthode d'abonnement.
  • Après subscribe(), redirigez l'utilisateur vers paymentUrl et gérez l'URL de retour dans votre application.
  • Utilisez getActiveSubscriptions() pour restreindre les fonctionnalités premium dans votre interface utilisateur.

Définition du module Subscriptions​


const { Subscriptions } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

🔗 Documentation Connexe​