Skip to main content
Il indique s’il a rejoint ou quitté le compte, son niveau d’accès et la dernière fois qu’il a ouvert le contenu du compte. Utilisez l’API Members pour lister et rechercher les membres d’un compte, récupérer un membre et consulter le journal d’activité d’un membre. Les enregistrements de membres sont créés et gérés par le cycle de vie des abonnements ; pour accorder ou révoquer un accès, utilisez plutôt les abonnements.
Remplace la ressource Legacy Members. Les intégrations Legacy existantes continuent de fonctionner ; consultez Versions de l’API pour le contrat de stabilité.

Endpoints

Attributs

string
requis
ID du membre, préfixé par mber_.
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
requis
Le compte auquel appartient ce membre, préfixé par biz_.
string
requis
Date de création de l’enregistrement du membre, sous forme de timestamp ISO 8601.
string
requis
Le nom à afficher pour ce membre : le nom de l’utilisateur, ou son nom d’utilisateur s’il n’a pas défini de nom. Le nom de l’entreprise acheteuse lorsque user vaut null.
object | null
requis
Le revenu brut de l’utilisateur sur Whop, en USD, actualisé périodiquement. null lorsque l’utilisateur masque ses gains ou que l’acheteur est une autre entreprise.

Properties

string
requis
Revenu brut en USD sur les dernières 24 heures.
string
requis
Revenu brut en USD sur les 30 derniers jours.
string
requis
Revenu brut en USD sur les 7 derniers jours.
string
requis
Revenu brut en USD depuis le début.
string | null
requis
L’adresse e-mail de l’utilisateur. null sans member:email:read sur le compte, lorsque l’acheteur est une autre entreprise, ou lorsque l’utilisateur n’a pas d’adresse e-mail attribuée.
string
requis
Date à laquelle le membre a rejoint le compte pour la première fois, sous forme de timestamp ISO 8601.
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.
message | null
requis
Ce qui s’est passé à last_activity_at. object indique de quel type d’activité il s’agit. null sans support_chat:read sur le compte, ou lorsque last_activity_at vaut null.

Properties

string
requis
L’ID du message.
object | null
requis
L’expéditeur du message : le membre ou une personne de l’équipe du compte. null lorsque le compte de l’expéditeur n’existe plus.

Properties

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.

Properties

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
string
requis
Le chat d’assistance dans lequel le message a été envoyé.
string
requis
Date d’envoi du message, sous forme de timestamp ISO 8601.
string
requis
Toujours message.
string | null
requis
Le texte du message sans mise en forme. null lorsque le message ne contient pas de texte, comme une pièce jointe seule.
string | null
requis
Date de la dernière interaction entre le membre et le compte, sous forme de timestamp ISO 8601. Par exemple, un message dans le chat d’assistance du membre.
object | null
requis
Vos propres données clé-valeur stockées sur ce membre. null lorsqu’aucune n’est définie.
string | null
requis
Le dernier état du cycle de vie du membre sur le compte, déduit de ses abonnements, comme paid_subscriber, canceling ou churned. null jusqu’à son premier calcul.Options disponibles : canceling, churned, finished_split_pay, paused, paid_subscriber, paid_once, expiring, joined, left, trialing, pending_entry, renewing, past_due
string | null
requis
Date à laquelle most_recent_action a pris effet, sous forme de timestamp ISO 8601. null lorsque most_recent_action vaut null.
string | null
requis
Le nom que le compte a attribué à ce client avec PATCH /members/:id. Les factures l’affichent comme nom du client sur chaque facture de ce membre, à la place du nom de l’utilisateur. null lorsque le compte n’en a pas défini.
string | null
requis
Le numéro de téléphone du membre : le numéro le plus récent collecté (ou vérifié) lors du checkout, sinon le numéro de son compte lorsqu’il l’a partagé avec ce vendeur. null sans member:phone:read sur le compte, ou lorsqu’il n’y en a aucun.
string
requis
joined tant que le membre fait partie du compte, left après son départ.Options disponibles : joined, left
number
requis
Le solde de tokens actuel du membre pour ce compte, calculé à partir des transactions de tokens.
string | null
requis
unsubscribed dès que le membre se désinscrit des communications marketing du compte, null tant qu’il est inscrit. Seul le membre peut le modifier.Options disponibles : unsubscribed
object
requis
Le montant dépensé par le membre pour les produits du compte, en USD.

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.
object | null
requis
L’utilisateur derrière ce membre. null lorsque l’acheteur est une autre entreprise plutôt qu’une personne.

Properties

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
La ville de l’utilisateur, déduite de son adresse IP. null lorsqu’elle est inconnue ou que l’utilisateur a désactivé le partage de localisation.
string | null
requis
Le pays de l’utilisateur sous forme de code ISO 3166-1 alpha-2, comme US, déduit de son adresse IP. null lorsqu’il est inconnu ou que l’utilisateur a désactivé le partage de localisation.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.

Properties

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.
string | null
requis
Le code d’État ou de région de l’utilisateur, comme CA, déduit de son adresse IP. null lorsqu’il est inconnu ou que l’utilisateur a désactivé le partage de localisation.
string
requis
Nom d’utilisateur public.
Member