Skip to main content
L’inscription n’accorde pas d’adhésion et ne débite aucun moyen de paiement ; le vendeur approuve ou refuse chaque inscription. Utilisez l’API Entrées de liste d’attente pour rejoindre une liste d’attente, consulter ou annuler vos propres inscriptions, et approuver ou refuser les inscriptions des comptes que vous gérez.

Endpoints

Attributs

string
requis
L’ID de l’inscription à la liste d’attente, préfixé par entry_.
string
requis
Le compte vendeur, préfixé par biz_.
string | null
requis
Raison de l’échec de la dernière tentative d’approbation, ou null s’il n’y en a eu aucun. plan_unavailable — la variante, le produit ou le compte vendeur a été supprimé. already_member — l’utilisateur a déjà une adhésion sur un produit limité à une par utilisateur. checkout_failed — le checkout a échoué, généralement en raison d’un paiement refusé, et l’inscription a été refusée. unknown — un autre échec ; réessayez. Effacé lorsque l’approbation est remise en file d’attente.Options disponibles : plan_unavailable, already_member, checkout_failed, unknown
object | null
requis
Le compte au nom duquel l’inscription a été soumise, ou null lorsque l’utilisateur s’est inscrit pour lui-même.

Propriétés

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 public du compte, utilisé dans le chemin de la vitrine whop.com/\{route}.
string
requis
Nom d’affichage du compte.
string | null
requis
Le compte au nom duquel l’inscription a été soumise, préfixé par biz_, ou null lorsque l’utilisateur s’est inscrit pour lui-même.
string
requis
Date de soumission de cette inscription, sous forme d’horodatage ISO 8601.
object[]
requis
Les réponses de l’acheteur aux questions du checkout.

Propriétés

string
requis
L’ID de la réponse, préfixé par cfrp_.
string
requis
La réponse de l’acheteur.
string
requis
La question affichée lors de la soumission de l’inscription.
string | null
requis
L’adhésion créée pour cette inscription, préfixée par mem_, ou null s’il n’y en a pas. Vérifiez le statut de l’adhésion pour déterminer l’accès.
object
requis
Métadonnées clé-valeur personnalisées associées à cette inscription.
object | null
requis
Le produit auquel appartient cette inscription, ou null lorsque la variante n’a pas de produit.

Propriétés

string
requis
ID du produit, préfixé par prod_.
string
requis
Nom d’affichage du produit.
string | null
requis
Le produit auquel appartient cette inscription, préfixé par prod_, ou null lorsque la variante n’a pas de produit.
string
requis
L’état actuel de l’inscription. L’approbation s’exécute de manière asynchrone, de sorte qu’une inscription reste pending jusqu’à la fin du traitement. approved seul ne prouve pas l’existence d’une adhésion active ; vérifiez membership_id.Options disponibles : pending, approved, denied, canceled
string
requis
Date de dernière modification de cette inscription, sous forme d’horodatage ISO 8601.
object
requis
L’utilisateur qui a soumis cette inscription. Pour une inscription soumise par les propres identifiants d’un compte, le propriétaire du compte.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
L’objet contenant l’avatar. Son url est toujours présente et correspond à une image de remplacement générée lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image de remplacement générée lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
string
requis
L’utilisateur qui a soumis cette inscription, préfixé par user_. Pour une inscription soumise par les propres identifiants d’un compte, le propriétaire du compte.
object
requis
La variante à laquelle appartient cette inscription.

Propriétés

string
requis
ID de la variante, préfixé par plan_.
number | null
requis
Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un abonnement mensuel ou 365 pour un abonnement annuel. null pour les variantes à paiement unique.
string
requis
Modèle de facturation de cette variante : one_time ou renewal.Options disponibles : renewal, one_time
string | null
requis
Description de la variante visible par le client. 1000 caractères maximum. null si aucune description n’est définie.
object
requis
Ce que le checkout prélève immédiatement. amount vaut "0.00" lorsque le premier prélèvement est gratuit, comme pendant un essai.

Propriétés

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 pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Le prélèvement récurrent tous les billing_period jours. amount vaut "0.00" pour les variantes à paiement unique.

Propriétés

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 pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string | null
requis
Nom d’affichage de la variante présenté aux clients. null si aucun titre n’a été défini.
number | null
requis
Jours d’essai gratuit configurés avant le premier prélèvement de renouvellement. null si aucun essai n’est configuré.
string
requis
La variante à laquelle appartient cette inscription, préfixée par plan_.
WaitlistEntry