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.

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.

🚀 Démarrage rapide​

Initialisez le module depuis defineOneEntry :


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

Abonnez l'utilisateur actuel à un plan et redirigez-le vers la session de paiement (auth requis) :

// Create a subscription for the "premium" plan.
const session = await Subscriptions.subscribe({ marker: "premium" });

// Send the user to the payment page to complete the first payment.
window.location.href = session.paymentUrl;

✨ 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() renvoie une session de paiement (ICreatedSubscription) — 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​

📊 Tableau de référence rapide​

MéthodeDescription
subscribe() 🔐Crée un abonnement et obtient une session de paiement
getAllSubscriptions() 🔐Obtenez tous les marqueurs d'abonnement disponibles
getActiveSubscriptions() 🔐Obtenez les marqueurs des abonnements actifs de l'utilisateur
cancelSubscription() 🔐Annule un abonnement
recoverSubscriptions() 🔐Récupère un abonnement via le Billing Portal

🔐 = Nécessite une autorisation

❓ Questions fréquentes (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 référence chaque plan par son marqueur.

Que renvoie subscribe() ?​

Il renvoie 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.

🔗 Documentation connexe​