Skip to main content
Une adhésion (Membership) est la relation active entre un utilisateur et un produit. Elle suit l’accès, le statut de facturation et le calendrier de renouvellement. Vous ne créez pas les adhésions directement, car le checkout s’en charge pour vous. Une fois qu’une adhésion existe, vous pouvez la consulter, mettre en pause ou annuler la facturation, offrir du temps gratuit ou mettre à jour les métadonnées.
La plupart des apps n’ont pas du tout besoin de gérer les adhésions. Utilisez ces méthodes lorsque vous créez des outils d’administration, des parcours de support client ou des tableaux de bord en libre-service permettant aux utilisateurs de mettre en pause ou d’annuler.

Le cycle de vie en un coup d’œil

Récupérer et lister

Mettre en pause et reprendre

La mise en pause arrête le prochain cycle de facturation. L’utilisateur conserve son accès actuel jusqu’à la fin de la période en cours, mais le renouvellement ne se déclenche pas. Passez until pour planifier une reprise automatique.

Annuler

Deux modes d’annulation. cancel_at_period_end: true conserve l’accès jusqu’à la date de renouvellement actuelle, puis désactive l’adhésion. Omettez-le (ou passez false) pour révoquer l’accès immédiatement.
cancel_at_period_end: true passe cancel_at_period_end à true sur l’adhésion. L’utilisateur conserve l’accès jusqu’au renouvellement, puis l’adhésion est désactivée et membership.updated est déclenché avec previous_attributes.status défini sur le statut précédent. Omettre le champ révoque l’accès immédiatement : envoyez-le donc explicitement chaque fois que vous souhaitez annuler en fin de période.

Rétablir une adhésion annulée

Si l’utilisateur change d’avis avant la fin de la période, supprimez l’annulation de fin de période en attente avec une mise à jour. Sans effet si l’annulation de l’adhésion n’était pas planifiée.

Ajouter des jours gratuits

Offrez à l’utilisateur du temps supplémentaire sur sa période en cours. La prochaine date de renouvellement est repoussée de days. Utile en cas d’interruption de service, de geste commercial du support ou de récompense de parrainage.
days accepte une valeur de 1 à 1095 (3 ans).

Mettre à jour les métadonnées

Modifiez des métadonnées arbitraires ou d’autres champs modifiables de l’adhésion.

Écouter les événements du cycle de vie

Abonnez-vous via les webhooks. Voici les événements déclenchés tout au long du cycle de vie : Pour pause / resume / extend, le statut de l’adhésion ne change pas, donc aucun événement d’activation/désactivation n’est déclenché. Si vous devez confirmer que la modification a réussi, récupérez l’adhésion après l’appel ou interrogez-la selon votre propre calendrier.

Étapes suivantes

Accepter des paiements

L’origine des adhésions. Checkouts ponctuels et récurrents.

Enregistrer des moyens de paiement

Cartes enregistrées pour les renouvellements futurs et la facturation hors session.

Écouter les webhooks

Réagissez aux activations, désactivations et changements d’annulation.

Référence API des adhésions

La ressource complète : champs, statuts et tous les endpoints.