Skip to main content
Elle suit l’état de facturation (active, trialing, past_due, etc.), la période en cours, les annulations en attente, les métadonnées personnalisées et la clé de licence logicielle lorsque le produit inclut une licence. Utilisez l’API Memberships pour lister les abonnements d’un compte ou les vôtres, en récupérer un par ID ou par clé de licence, inviter un destinataire à rejoindre via une variante gratuite, et gérer le cycle de vie : annuler immédiatement ou en fin de période, revenir sur une annulation planifiée, suspendre et reprendre l’encaissement des paiements, prolonger ou réactiver l’accès, appliquer un code promo ou un affilié, modifier la fréquence de renouvellement, resynchroniser l’accès, générer un lien de transfert et mettre à jour les métadonnées.
Remplace la ressource Legacy Memberships. Les intégrations Legacy existantes continuent de fonctionner ; consultez Versions de l’API pour le contrat de stabilité.

Endpoints

Attributs

string
requis
ID de l’abonnement, préfixé par mem_.
object
requis
Le compte (vendeur) auquel appartient cet abonnement.

Properties

string
requis
ID du compte, préfixé par biz_.
string | null
requis
URL de l’image du logo du compte. null lorsque le compte n’en a pas défini.
string
requis
Identifiant de route publique du compte, utilisé dans le chemin de la vitrine whop.com/\{route}.
string
requis
Nom d’affichage du compte.
object | null
requis
La commission d’affiliation de l’abonnement. null sans affilié, sans affiliate:basic:read sur le compte, et toujours dans les webhooks.

Properties

string
requis
ID de l’affilié, préfixé par aff_.
string
requis
Indique si la commission est versée uniquement sur le premier paiement de l’abonnement ou sur tous ses paiements.Options disponibles : first_payment, all_payments
object | null
requis
La commission forfaitaire dans la devise de l’abonnement, ou null pour un pourcentage.

Properties

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision à laquelle le débit lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est débité en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
number | null
requis
La commission en pourcentage, exprimée en points de pourcentage, de sorte que 20 signifie 20 %, ou null pour un forfait.
string
requis
La manière dont le taux de commission a été défini : custom pour un taux défini pour cet affilié, member pour le taux d’affiliation des membres du plan ou du produit, global pour le taux d’affiliation global du produit, ou marketplace pour un parrainage de la marketplace Whop.Options disponibles : custom, member, marketplace, global
string
requis
Indique si la commission est un pourcentage ou un forfait.Options disponibles : flat_fee, percentage
boolean
requis
Indique si cet abonnement verse des commissions d’affiliation. false signifie que l’affilié est conservé sur l’abonnement mais n’est plus rémunéré.
string
requis
ID de l’utilisateur de l’affilié, préfixé par user_.
integer | null
requis
Nombre de jours entre les débits récurrents. null pour les abonnements sans renouvellement ou ceux ayant plusieurs calendriers de renouvellement.
boolean
requis
Indique si l’abonnement est configuré pour être annulé à la fin de la période de facturation en cours. Pertinent uniquement pour les variantes récurrentes.
string | null
requis
La catégorie choisie par le membre pour expliquer son annulation. null lorsqu’aucune catégorie n’a été choisie.Options disponibles : too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testing
string | null
requis
Date de la demande d’annulation, ou date d’annulation de l’abonnement si aucune date de demande n’est enregistrée, sous forme de timestamp ISO 8601. null lorsqu’aucune des deux n’est enregistrée.
string | null
requis
Explication en texte libre fournie lors de l’annulation. null lorsqu’aucune raison n’a été fournie.
string | null
requis
La manière dont les renouvellements sont encaissés. charge_automatically débite le moyen de paiement enregistré à chaque période ; send_invoice envoie une facture par e-mail à l’acheteur à chaque période. null lorsque non défini.Options disponibles : charge_automatically, send_invoice
string
requis
Date de création de l’abonnement, sous forme de timestamp ISO 8601.
string | null
requis
Date de renouvellement de la période de facturation en cours, ou date d’expiration d’un abonnement sans renouvellement, sous forme de timestamp ISO 8601. null pour les achats uniques sans expiration.
string | null
requis
Date de début de la période de facturation en cours, sous forme de timestamp ISO 8601. null lorsqu’aucune période de facturation n’est enregistrée.
string | null
requis
Date de fin de l’accès pour un abonnement à expiration fixe, sous forme de timestamp ISO 8601. null lorsque l’abonnement n’a pas d’expiration, comme un abonnement renouvelable.
object[] | null
requis
Les comptes du membre sur des plateformes externes, comme Discord et Telegram. Vide lorsque le membre n’en a lié aucun. null dans les webhooks.

Properties

string
requis
L’ID utilisateur du membre sur la plateforme, comme un ID utilisateur Discord. Préfixé par la plateforme (discord_\<external_id>), c’est la valeur external_account sur laquelle filtre List Memberships.
string
requis
La plateforme sur laquelle se trouve le compte du membre.Options disponibles : discord, telegram
string | null
requis
Le nom d’utilisateur du membre sur la plateforme. null lorsque Whop ne le connaît pas, par exemple pour un abonnement importé avec uniquement un ID Discord.
object | null
requis
La raison d’annulation propre au compte choisie par le membre, telle qu’il l’a vue. null lorsque le membre a choisi une catégorie par défaut ou n’a donné aucune raison.

Properties

string
requis
Le libellé de l’option au moment où le membre l’a choisie. Renommer l’option par la suite ne le modifie pas.
object
requis
Le prix initial actuel de la variante, dans la devise de la variante. Il s’agit d’un prix catalogue, pas nécessairement de ce que l’acheteur a payé. amount vaut "0.00" lorsque le premier débit est gratuit.

Properties

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision à laquelle le débit lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est débité en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string | null
requis
La clé de licence logicielle de cet abonnement. Présente uniquement lorsque le produit inclut une expérience de licence logicielle.
string | null
requis
URL où l’acheteur peut se connecter pour gérer sa facturation. null sans enregistrement de membre ou sauf si l’appelant est l’acheteur ou dispose de member:manage sur le compte.
object | null
requis
L’enregistrement de membre de l’appelant sur le compte. Présent uniquement lorsque l’abonnement appartient à l’appelant ; null pour les lectures côté vendeur.

Properties

string
requis
Ce à quoi le membre peut accéder sur le compte : customer pour les membres payants, admin pour les membres de l’équipe, no_access une fois que tous les accès ont expiré.Options disponibles : no_access, admin, customer
string | null
requis
Date à laquelle le membre a ouvert le contenu du compte pour la dernière fois, sous forme de timestamp ISO 8601. null s’il ne l’a jamais fait.
number | null
requis
La position de tri du membre dans la liste de comptes de l’acheteur. null jusqu’à ce qu’il l’organise.
string | null
requis
L’enregistrement de membre de l’acheteur sur le compte, préfixé par mber_. null lorsque l’abonnement n’a pas d’enregistrement de membre, comme un abonnement non réclamé.
object
requis
Paires clé-valeur personnalisées stockées sur l’abonnement, couramment utilisées pour les licences logicielles.
string | null
requis
Le dernier événement du cycle de vie de l’abonnement, comme renewing_on ou canceled_on. À associer à most_recent_action_at. null lorsqu’aucun n’est enregistré.Options disponibles : canceled_on, finished_split_pay_at, canceling_on, ending_on, renewing_on, past_due, next_payment_attempt, paused_at, trial_ends_at, unresolved_at, trial_canceling_on
string | null
requis
Date à laquelle most_recent_action a eu lieu ou est planifié, sous forme de timestamp ISO 8601. Une date future pour les événements à venir comme renewing_on. null lorsqu’aucune action n’est enregistrée.
string | null
requis
Le numéro de téléphone de l’acheteur enregistré pour cet abonnement, ou null. Le numéro collecté (ou vérifié) lors du checkout lorsque la collecte du téléphone par le vendeur est activée ; sinon, le numéro du compte de l’acheteur lorsqu’il l’a partagé avec ce vendeur.
object
requis
Le produit auquel cet abonnement donne accès.

Properties

string
requis
ID du produit, préfixé par prod_.
string | null
requis
URL de l’image du logo du produit. null lorsque le produit n’a pas de logo.
string
requis
Nom d’affichage du produit.
string
requis
Le produit auquel cet abonnement donne accès, préfixé par prod_.
string | null
requis
Le code promo appliquant une remise à cet abonnement, préfixé par promo_. null lorsqu’aucun n’est appliqué. Défini lors du checkout ou par Apply Promo Code to Membership.
object | null
requis
Le prix de renouvellement de la variante, dans la devise de la variante, après application de tout code promo encore valable. Un abonnement facturé dans la devise locale de l’acheteur est débité de ce prix converti au taux de change à chaque date de facturation. null pour les abonnements sans renouvellement.

Properties

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision à laquelle le débit lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est débité en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
integer | null
requis
Échéances payées comptabilisées jusqu’à présent sur un abonnement en paiement fractionné. null lorsque l’abonnement n’est pas en paiement fractionné, ou avant que sa première échéance ne soit comptabilisée.
integer | null
requis
Échéances de paiement requises avant que l’abonnement cesse d’être facturé. null lorsque l’abonnement n’est pas en paiement fractionné.
string
requis
État de facturation de l’abonnement. Les abonnements active/trialing donnent accès ; past_due correspond à la période de grâce après un paiement échoué ; les achats uniques completed conservent l’accès ; canceled/expired non.Options disponibles : trialing, active, past_due, completed, canceled, expired, unresolved
string
requis
Date de la dernière modification de l’abonnement, sous forme de timestamp ISO 8601. Reflète la modification la plus récente de l’abonnement lui-même, ce qui vous permet d’effectuer un rapprochement avec les nouvelles tentatives, rejeux et backfills de webhooks.
string | null
requis
L’acheteur, préfixé par user_. null lorsque l’acheteur est une autre entreprise ou que l’abonnement n’est pas réclamé.
string
requis
La variante achetée par l’acheteur, préfixée par plan_.
Membership