Skip to main content
Utilisez les comptes pour les clients, créateurs, marchands, vendeurs ou entreprises connectées que votre intégration prend en charge. Utilisez l’API Accounts pour créer des comptes, lister les comptes visibles avec vos identifiants, récupérer ou mettre à jour un compte, suspendre ou supprimer un sous-compte géré par votre plateforme, et récupérer le compte associé à la clé API actuelle. Les champs business_type, industry_group et industry_type classent les comptes. Consultez le glossaire des types d’entreprises et des secteurs pour connaître toutes les valeurs valides.

Endpoints

Majorations de frais

Les majorations de frais permettent à une plateforme d’ajouter des frais ou de subventionner les frais de versement de ses sous-comptes. Gérez-les via le document des frais du compte : définissez des valeurs par défaut sur le compte de plateforme ou remplacez des frais individuels sur un sous-compte. Consultez Majorations et subventions de frais pour des exemples, les limites et les exigences de financement.

Endpoints des frais

Utilisez la clé API du compte de plateforme disposant de l’autorisation company:update_child_fees pour configurer les majorations. Chaque majoration renvoyée inclut adjustable et unadjustable_reason afin que votre intégration puisse déterminer si la modification est possible.

Lire les frais

La section markups contient les taux effectifs du sous-compte. La section child_markups d’un compte de plateforme contient ses valeurs par défaut pour les sous-comptes. Le source d’une majoration vaut custom lorsqu’elle est configurée à ce niveau, ou default lorsqu’elle se rabat sur un taux hérité ou sur zéro. Son champ default indique le taux qui s’appliquerait si la majoration personnalisée était supprimée. Les montants fixes renvoyés utilisent l’objet Money ; les mises à jour acceptent fixed sous forme de nombre en dollars américains.

Définir les valeurs par défaut de la plateforme

Mettez à jour child_markups sur le compte de plateforme. Cet exemple définit une majoration de paiement de 2 % sans frais fixes :
percentage: 2 signifie 2 %. Les valeurs par défaut s’appliquent aux sous-comptes sans remplacement pour ces frais. Les majorations de paiement s’appliquent lorsqu’aucuns frais d’application de checkout ne sont définis.

Définir un remplacement pour un sous-compte

Mettez à jour markups sur le sous-compte. Cet exemple remplace sa majoration de paiement héritée par 1 % plus 0,25 $ :
Seules les clés que vous envoyez changent. Pour les autres types de transactions, utilisez transfers, crypto_swaps, deposits indexés par rail, ou payouts indexés par moyen de versement. Consultez l’endpoint de mise à jour pour connaître les clés prises en charge et le schéma de la requête.

Supprimer une majoration

Envoyez null pour la majoration afin de la supprimer. Supprimer le remplacement d’un sous-compte rétablit la valeur par défaut de sa plateforme, ou zéro si aucune valeur par défaut n’est configurée :
Pour supprimer une valeur par défaut de la plateforme, envoyez child_markups: { payments: null } au compte de plateforme. Un { percentage: 0, fixed: 0 } explicite reste un taux configuré ; utilisez null pour rétablir l’héritage. Un compte publie ses documents juridiques sous forme de fichiers PDF : terms_of_service, privacy_policy, return_policy, cancellation_policy, shipping_policy et eula. Chacun est renvoyé en lecture sous forme de File et se définit via Update Account avec l’id d’un fichier que vous avez téléversé. Les nouveaux litiges utilisent par défaut ces documents comme preuves de politique. L’emplacement de politique d’annulation prend cancellation_policy, puis terms_of_service, puis return_policy. L’emplacement de politique de remboursement prend return_policy, puis terms_of_service. Chaque emplacement se rabat sur la politique de la plateforme Whop lorsqu’aucun n’est défini, et shipping_policy est joint aux litiges portant sur des biens physiques. Définissez-les une fois ici, et n’utilisez Upload Dispute Evidence que lorsqu’un litige nécessite une version différente d’une politique.
Envoyez null pour un document afin de le supprimer. Seuls les fichiers PDF sont acceptés.

Attributs

string
requis
ID du compte, préfixé par biz_.
number | null
requis
Dépenses publicitaires facturées sur toute la durée de vie du compte, en USD. Calculé uniquement sur list pour les appelants disposant de stats:read sur le compte ; null sinon.
object[]
requis
Avoirs du compte, chacun avec sa valeur en USD. Vide lorsque total_usd vaut null.

Propriétés

string
requis
Montant total détenu en unités natives, sous forme de chaîne décimale.
object
requis
Solde réparti en montants disponible, en attente et en réserve, sous forme de chaînes décimales en unités natives, avec les jours où le montant en attente devrait être réglé.

Propriétés

string
requis
Montant que vous pouvez dépenser, envoyer ou retirer dès maintenant, en unités natives, sous forme de chaîne décimale.
string
requis
La part de pending qui est déjà réglée et attend d’être transférée vers le portefeuille crypto du compte ou la Whop Card, où elle devient available. Le transfert commence généralement dans l’heure ; pendant son exécution, le montant est indiqué dans in_transit à la place. L’argent déplacé uniquement pour compléter le solde minimum conservé du compte n’est pas inclus. En unités natives, sous forme de chaîne décimale.
string
requis
Montant en cours de transfert entre les propres destinations du compte, comme une recharge de carte. En unités natives, sous forme de chaîne décimale.
string
requis
Montant provenant de paiements récents encore en cours de règlement, en unités natives, sous forme de chaîne décimale.
object[]
requis
Date à laquelle le montant en attente devrait être réglé, une entrée par jour, la plus proche en premier. L’argent sans jour de règlement prévu, y compris finishing_settlement, est exclu : ces entrées plus finishing_settlement peuvent donc totaliser moins que pending, jamais plus.

Propriétés

string
requis
Montant attendu ce jour-là, en unités natives, sous forme de chaîne décimale.
string
requis
Le jour où cet argent devrait finir d’être réglé, sous forme de date ISO 8601.
string
requis
Montant retenu, en unités natives, sous forme de chaîne décimale. Récupérez les réserves du compte pour savoir pourquoi il est retenu et quand il sera débloqué.
string | null
requis
URL de l’icône de l’avoir.
string
requis
Le nom d’affichage de l’avoir
number | null
requis
Prix en USD par unité, ou null lorsqu’aucun taux de change n’est disponible.
string
requis
Symbole d’affichage de l’avoir, comme USDT, cbBTC ou EUR.
string | null
requis
Valeur de l’avoir en USD, ou null lorsqu’aucun taux de change n’est disponible.
string | null
requis
URL de l’image de bannière du compte.
object | null
requis
Adresse professionnelle du compte utilisée pour calculer les taxes, avec line1, line2, city, state, postal_code et country. null lorsqu’aucune adresse n’est définie.
string | null
requis
La raison sociale du compte utilisée avec son adresse fiscale.
string | null
requis
Catégorie d’activité générale du compte. Consultez le glossaire des types d’entreprises et des secteurs pour connaître les valeurs valides.
boolean
requis
Indique si les fonds en attente peuvent être transférés de ce compte de plateforme vers ses sous-comptes.
object | null
requis
Le document de politique d’annulation du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
object | null
requis
Rails de paiement activés pour ce compte, chacun active, inactive ou pending (intégration ou examen en cours). Calculé uniquement sur retrieve et me pour les appelants disposant de la portée company:balance:read ; null sinon.

Propriétés

string
requis
Encaissements bancaires : prélèvements, virements et rails bancaires locauxOptions disponibles : active, inactive, pending
string
requis
Encaissements en paiement fractionné (buy-now-pay-later) ; nécessite une approbationOptions disponibles : active, inactive, pending
string
requis
Encaissements par carte, y compris Apple Pay et Google PayOptions disponibles : active, inactive, pending
string
requis
Dépôts par virement bancaire ou ACH sur le compte bancaire virtuel du compteOptions disponibles : active, inactive, pending
string
requis
Recharges de solde en débitant un moyen de paiement enregistréOptions disponibles : active, inactive, pending
string
requis
Émission de cartes Whop ; nécessite l’approbation de la demande de carteOptions disponibles : active, inactive, pending
string
requis
Dépôts on-chain sur le portefeuille crypto du compteOptions disponibles : active, inactive, pending
string
requis
Versements on-chain vers un portefeuille cryptoOptions disponibles : active, inactive, pending
string
requis
Versements instantanés vers une destination de versement éligibleOptions disponibles : active, inactive, pending
string
requis
Lancement de campagnes publicitaires via Whop Ads. inactive tant que l’identité ou l’entreprise du compte n’est pas vérifiée, tant qu’un contrat de services publicitaires demandé attend la signature du compte, et tant que le compte est suspendu de Whop Ads.Options disponibles : active, inactive, pending
string
requis
Versements standard vers une destination de versement externeOptions disponibles : active, inactive, pending
string
requis
Transferts vers d’autres comptesOptions disponibles : active, inactive, pending
object | null
requis
Détails de la demande Whop Cards du compte. Renvoyé sur list, retrieve et me pour les appelants disposant de la portée company:balance:read ; null sinon, ou lorsque le compte n’a aucune demande de carte ni examen de demande bloquant.

Propriétés

string | null
requis
Motif pour lequel l’émetteur de la carte a refusé la demande. unsupported_state remplace unsupported_region pour une personne ou une entreprise vérifiée aux États-Unis. compliance couvre les contrôles de sanctions, de personnes politiquement exposées et de médias défavorables. other couvre les motifs qui ne figurent pas dans cette liste. null lorsque status n’est pas denied, ou lorsque l’émetteur n’a pas refusé la demande.Options disponibles : compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
requis
Indique si la demande de carte vérifie une entreprise (business, KYB) ou une personne (individual, identité du consommateur). null lorsque la demande n’est pas encore liée à une vérification.Options disponibles : individual, business
string
requis
L’état de la demande de carte. approved signifie que des cartes peuvent être émises. needs_verification signifie que le demandeur n’a pas encore terminé la vérification d’identité ; needs_information signifie qu’il l’a fait, mais que les documents ont été rejetés pour un motif corrigeable et doivent être soumis à nouveau. pending et manual_review sont en cours. denied, locked et canceled sont définitifs.Options disponibles : approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
boolean
requis
Indique si le paiement affiche un champ de numéro de TVA/identifiant fiscal que les acheteurs peuvent renseigner facultativement. N’exige pas de numéro de TVA pour acheter.
object
requis
État de création de société du compte, géré via Form Company. Un status draft jusqu’au paiement du checkout de création, puis l’avancement du dépôt avec les documents téléchargeables et les signatures en attente. Vide lorsque l’état de création est temporairement indisponible.

Propriétés

object[]
Documents de création disponibles au téléchargement, comme les Articles of Organization et la lettre de confirmation de l’EIN. Présent dès que status quitte draft.

Propriétés

string
requis
ID du document, préfixé par file_.
string
requis
Nom lisible du document, comme Articles of Organization.
string
requis
Catégorie du document : articles_of_organization, operating_agreement, ein_letter, signed_ss4, signed_form8821, ou mail pour le courrier postal reçu au nom de la société.
string
requis
URL CDN pour télécharger le document.
boolean
Indique si l’EIN de la société a été émis par l’IRS. Présent dès que status quitte draft.
Nom enregistré de la société, y compris la forme juridique, par exemple Acme, LLC. Présent dès que status quitte draft.
object
Formulaires IRS en attente de la signature d’un fondateur, chacun avec une URL de signature hébergée. Présent dès que status quitte draft ; vide lorsqu’il n’y a rien à signer.

Propriétés

object
État de signature du formulaire IRS 8821, l’autorisation d’accès aux informations fiscales. Présent uniquement tant que le formulaire nécessite encore une action du fondateur.

Propriétés

string
Date d’expiration de l’URL de signature, sous forme d’horodatage ISO 8601. Présent uniquement lorsque l’URL de signature est incluse.
string
requis
pending lorsqu’une session de signature est prête pour le fondateur ; unknown lorsque l’état de la signature n’a pas pu être déterminé.Options disponibles : pending, unknown
string
URL de signature hébergée où le fondateur remplit le formulaire. Présente tant que status vaut pending et que l’appelant dispose de incorporation:write. Omise des webhooks.
object
État de signature du formulaire IRS SS-4, la demande d’EIN. Présent uniquement tant que le formulaire nécessite encore une action du fondateur.

Propriétés

string
Date d’expiration de l’URL de signature, sous forme d’horodatage ISO 8601. Présent uniquement lorsque l’URL de signature est incluse.
string
requis
pending lorsqu’une session de signature est prête pour le fondateur ; unknown lorsque l’état de la signature n’a pas pu être déterminé.Options disponibles : pending, unknown
string
URL de signature hébergée où le fondateur remplit le formulaire. Présente tant que status vaut pending et que l’appelant dispose de incorporation:write. Omise des webhooks.
boolean
Indique si le dépôt de création de société auprès de l’État est terminé. Présent dès que status quitte draft.
string
Options disponibles : draft, processing, filed, rejected, completed
string | null
requis
Pays où se trouve le compte.
string
requis
Date de création du compte, sous forme d’horodatage ISO 8601.
integer | null
requis
Clients distincts ayant un reçu payé auprès du compte au cours des 30 derniers jours, actualisé toutes les quelques heures. Calculé uniquement sur retrieve pour les appelants disposant de stats:read sur le compte ; null sinon, ainsi que lorsque le décompte est indisponible.
string | null
requis
Description promotionnelle du compte.
integer
Nombre de membres de l’équipe qui relèvent directement de l’entreprise, sans responsable au-dessus d’eux. Présent sur les lectures d’un seul compte.
boolean
requis
Indique si Whop constitue et dépose les preuves de litige pour ce compte. L’activer inscrit le compte aux frais de succès facturés sur les litiges qu’il remporte.
boolean
requis
Indique si Economic Intelligence est activé pour le compte. Il se désactive automatiquement à la fin de sa période d’engagement. Tant qu’il est désactivé, le compte ne peut ni activer une expérience ni exécuter une recommandation.
string | null
requis
Adresse e-mail du propriétaire du compte.
object | null
requis
Le document de contrat de licence utilisateur final du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
L’identifiant propre à la plateforme parente pour ce sous-compte, unique parmi les sous-comptes de la plateforme. null lorsqu’il n’est pas défini.
object | null
requis
La demande de financement la plus récente du compte. Calculé uniquement sur retrieve et me pour les appelants disposant de la portée company:balance:read ; null sinon, ou lorsque le compte n’a jamais demandé de financement.

Propriétés

string
requis
L’ID de la demande de financement la plus récente du compte, commençant par inrq_. Récupérez-la pour connaître les exigences et les retours d’examen.
string
requis
L’état d’examen de la demande de financement la plus récente : requires_collection (en attente du marchand, y compris après une demande d’informations complémentaires), awaiting_review, approved, denied ou completed. L’activation des moyens de paiement par financement est indiquée par capabilities.accept_bnpl_payments.Options disponibles : requires_collection, awaiting_review, completed, approved, denied
string | null
requis
Date à partir de laquelle un compte suspendu peut verser son solde vers son propre moyen de versement, sous forme d’horodatage ISO 8601. Un litige peut la repousser. Calculé sur retrieve, me et suspend ; null sinon, lorsque status n’est pas suspended, et lorsque la suspension bloque le solde.
string[]
requis
Préférences de la page d’accueil publique du compte.Options disponibles : hide_member_count, hide_members_card
string | null
requis
Secteur d’activité spécifique du compte. Consultez le glossaire des types d’entreprises et des secteurs pour connaître les valeurs valides.
string | null
requis
Préfixe utilisé pour les factures du compte.
object | null
requis
La progression Whop Levels du owner du compte, comptabilisée sur l’ensemble des comptes qu’il possède, afin qu’ils affichent tous le même niveau. Calculé uniquement sur retrieve et me pour les appelants disposant de la portée company:basic:read ; null sinon, ainsi que lorsque le compte ne fait pas partie de Whop Levels.

Propriétés

integer
requis
Le niveau propre à ce compte, à partir de ses seuls points, de 0 à 10. current est plus élevé lorsque les autres comptes du propriétaire le font monter.
integer
requis
Le niveau qui s’applique : le plus élevé atteint par le propriétaire ce mois-ci ou au cours des 5 mois précédents, de 0 à 10.
integer
requis
Points gagnés ce mois-ci sur l’ensemble des comptes du propriétaire, plus ses points de partenaire, arrondis à l’inférieur. Un compte dont le solde mensuel est négatif compte pour zéro.
object
requis
Les points de ce mois-ci, répartis selon leur provenance. Chaque source est nette de ses remboursements : l’une d’elles peut donc être négative.

Propriétés

integer
requis
Points issus des frais Whop Ads payés, nets des remboursements : 10 par dollar, arrondis vers zéro.
integer
requis
Points issus des dépenses Whop Card capturées, nets des remboursements : 10 par dollar, arrondis vers zéro.
integer
requis
Points issus des comptes que le propriétaire a parrainés en tant que partenaire : 1 pour 3 points qu’ils gagnent, arrondis vers zéro.
integer
requis
Points issus du volume de trading de contrats perpétuels exécuté via Whop : 1 par dollar échangé, arrondis vers zéro.
string
requis
Date à laquelle les points de ce mois-ci sont remis à zéro, sous forme d’horodatage ISO 8601.
string | null
requis
URL de l’image du logo du compte.
object
requis
Métadonnées clé/valeur arbitraires fournies lors de la création du compte.
string | null
requis
Type d’intégration (onboarding) effectuée par le compte.Options disponibles : platform, seller
string | null
requis
URL de l’image Open Graph du compte.
string | null
requis
Variante de l’image Open Graph du compte.Options disponibles : white, black, orange
boolean
requis
Indique si l’orchestration des paiements est activée pour ce compte.
string | null
requis
Détails du type d’entreprise lorsque business_type vaut other.
string | null
requis
Détails du secteur lorsque industry_type vaut other.
object
requis
L’utilisateur unique qui possède le compte, dont l’e-mail est le email ci-dessus. À distinguer du rôle owner des membres de l’équipe, que n’importe quel nombre d’entre eux peut détenir.

Propriétés

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.

Propriétés

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.
object | null
requis
Compte parent des sous-comptes, ou null pour les comptes autonomes.

Propriétés

string
requis
ID du compte, préfixé par biz_.
object
Taux de majoration que ce parent facture au sous-compte lu, indexés par type de frais (par exemple crypto_deposit_markup), chacun avec percentage_fee et fixed_fee_usd. Résolus en donnant la priorité aux remplacements propres au sous-compte sur la valeur par défaut de la plateforme.
string | null
requis
URL de l’image du logo du compte.
string
requis
Identifiant de route public du compte.
string
requis
Nom d’affichage du compte.
object | null
Le partenaire de premier niveau actif du compte. Présent sur les réponses de retrieve ; null lorsqu’aucun partenaire de premier niveau actif n’est attribué au compte. Omis des autres réponses.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Adresse e-mail pour contacter le partenaire. Null lorsque le partenaire n’a pas ajouté sa propre adresse e-mail.
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.

Propriétés

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.
object | null
requis
Entreprise au nom de laquelle le partenaire a parrainé ce compte, lorsque le parrainage appartient à son équipe. null pour un parrainage personnel.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
string
requis
Nom d’utilisateur public.
string | null
requis
Date à laquelle l’utilisateur est devenu un Whop Partner vérifié, sous forme d’horodatage ISO 8601. Null s’il n’est pas vérifié.
object | null
requis
Contrôles de santé des paiements actuellement appliqués au compte. Calculé uniquement sur retrieve et me pour les appelants disposant de la portée company:balance:read ; null sinon.

Propriétés

object
requis
Paramètres de remboursement automatique pour les alertes de litige avant rétrofacturation.

Propriétés

boolean
requis
Indique si le propriétaire du compte est empêché de modifier ce seuil.
number | null
requis
Montant maximal d’alerte de litige remboursé automatiquement, en USD. null lorsque les remboursements automatiques sont désactivés.
number | null
requis
Frais facturés pour chaque alerte de litige, en USD. null lorsqu’ils sont indisponibles.
boolean
requis
Indique si 3-D Secure est imposé sur chaque paiement par carte au checkout. Le compte ne peut pas le contourner tant qu’il est défini.
boolean
requis
Indique si les contrôles de santé des paiements désactivent explicitement le financement. Ceci est indépendant de l’approbation du financement dans capabilities.accept_bnpl_payments.
number
requis
Pourcentage de frais de traitement supplémentaires pour le traitement à haut risque.
object[]
requis
Moyens de paiement pour lesquels le compte a été averti qu’ils approchent de leur seuil de taux de litiges. Chaque entrée contient payment_method, measure (disputes, disputes_and_tc40s ou fraud_disputes), warned_at sous forme d’horodatage ISO 8601, ainsi que rate, warning_rate et target_rate sous forme de fractions où 0.01 correspond à 1 %. Vide lorsqu’aucun n’a fait l’objet d’un avertissement. Un moyen averti est mis en pause, et apparaît dans restricted_payment_methods, s’il dépasse toujours son taux cible environ quatre semaines plus tard.
number
requis
Pourcentage de frais facturés lorsque le solde en attente, non encore réglé, est avancé pour alimenter le solde des cartes du compte, où 2 signifie 2 %. 0 lorsque le compte en est exempté.
integer
requis
Nombre de jours supplémentaires pendant lesquels les paiements restent en attente avant de devenir disponibles.
object
requis
Réserve actuellement appliquée au volume de paiements entrants.

Propriétés

integer
requis
Nombre de jours pendant lesquels les fonds en réserve sont retenus avant d’être libérés.
number | null
requis
Pourcentage du volume de paiements entrants retenu en réserve. null lorsqu’aucune réserve n’est appliquée.
object
requis
Paramètres de remboursement automatique pour les dossiers du centre de résolution.

Propriétés

number | null
requis
Montant maximal des dossiers du centre de résolution financés par carte remboursé automatiquement, en USD. null lorsque les remboursements automatiques sont désactivés pour les cartes.
number | null
requis
Montant maximal des dossiers du centre de résolution financés par financement remboursé automatiquement, en USD. null lorsque les remboursements automatiques sont désactivés pour le financement.
boolean
requis
Indique si le propriétaire du compte est empêché de modifier ces seuils.
number | null
requis
Montant maximal des dossiers du centre de résolution financés par PayPal remboursé automatiquement, en USD. null lorsque les remboursements automatiques sont désactivés pour PayPal.
string[]
requis
Marques de cartes bloquées au checkout pour ce compte. Vide lorsqu’aucune n’est bloquée. Le compte ne peut pas les réactiver lui-même.Options disponibles : card_visa, card_mastercard, card_american_express, card_discover_global_network, addi, affirm, afterpay_clearpay, alma, billie, capchase_pay, claritypay, flex_pay, klarna, kriya, kueski, mondu, oney, scalapay, sequra, sezzle, splitit, sunbit, tabby, tamara, zip, card_installments_three, card_installments_six, card_installments_twelve, oney_3x, oney_4x, klarna_pay_now, us_bank_account, sepa_debit, bacs_debit, au_becs_debit, acss_debit, pay_by_bank, payto, paypal, cashapp, venmo, amazon_pay, link, wechat_pay
string | null
requis
Raison pour laquelle les fonds en attente sans date de règlement ne bougent pas encore. kyc_incomplete, pending_information_request et update_payout_profile sont des actions que le marchand peut entreprendre. compliance_review signifie qu’une vérification déjà soumise par le marchand est en cours d’examen : ces fonds restent donc en attente jusqu’à sa validation. withdrawals_disabled signifie que Whop a bloqué les retraits : ces fonds ne peuvent donc pas devenir disponibles. null lorsqu’il n’y a aucune raison à afficher — encore en cours de compensation, ou retenus pour une raison non nommée ici.Options disponibles : kyc_incomplete, pending_information_request, update_payout_profile, compliance_review, withdrawals_disabled
object
requis
Comment le solde du compte est retiré automatiquement.

Propriétés

integer | null
requis
Jour d’exécution du retrait automatique : 0-6 (dimanche-samedi) pour weekly, 1-31 pour monthly. null pour manual et daily.
string
requis
Fréquence à laquelle le solde du compte est retiré automatiquement.Options disponibles : manual, daily, weekly, monthly
string | null
requis
Prochaine date d’exécution prévue du retrait automatique, sous forme de date ISO 8601. null pour manual et daily, où aucune date unique ne s’applique.
object | null
requis
Les moyens de paiement par défaut du compte au checkout. Le payment_method_configuration propre à une variante ou à une configuration de checkout est prioritaire. null lorsque le compte utilise les valeurs par défaut de la plateforme Whop.

Propriétés

string[]
requis
Moyens de paiement que ce checkout exclut, même lorsque les valeurs par défaut les proposeraient.
string[]
requis
Moyens de paiement que ce checkout propose en plus de ceux fournis par les valeurs par défaut.
boolean
requis
Indique si l’ensemble par défaut de Whop sert de point de départ. Lorsque false, seul enabled est proposé.
object[]
requis
Crédits de plateforme émis par Whop, par devise, lus depuis le cache des soldes. Les crédits ne peuvent être dépensés que pour des produits Whop éligibles, comme Whop Ads, ne peuvent jamais être retirés et ne sont pas inclus dans balances ni dans total_usd. Vide lorsque le compte n’en détient aucun ou que total_usd vaut null.

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 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
Le document de politique de confidentialité du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
object | null
requis
Code de classification fiscale appliqué par défaut aux produits du compte, avec id, name et product_type. null lorsqu’aucune valeur par défaut n’est définie.
OBSOLÈTE : utilisez plutôt l’endpoint GET /economic_intelligence?account_id=\{account_id}.

Propriétés

string
requis
La recommandation ; de nouvelles valeurs peuvent être ajoutées, gérez donc les actions inconnues de manière appropriéeOptions disponibles : theme_business, create_product, create_plan, verify_identity, connect_affiliate_program, create_promotion, migrate_from_stripe, accept_first_payment, launch_first_ad, launch_draft_campaign, increase_ad_budget, refresh_ad_creatives, fix_ad_billing, exclude_customers_from_ads, retarget_abandoned_checkouts, fix_funnel_dropoff, invite_team_member, enable_tax_collection, create_card, apply_for_financing
string[]
requis
Fonctionnalités que cela débloquerait, ou vide
string
requis
L’URL vers laquelle pointe l’appel à l’action
string
requis
Libellé du bouton
string
requis
Texte d’accompagnement, ou vide
string | null
requis
URL de l’icône d’illustration, ou null
integer | null
requis
Impact estimé de 0 à 100, ou null lorsqu’il n’est pas classé
string | null
requis
Raison pour laquelle cette action a été recommandée, ou null
string
requis
Toujours facultatif — jamais bloquantOptions disponibles : optional
string
requis
Titre de la recommandation
boolean
requis
Indique si les utilisateurs autorisés doivent activer l’authentification à deux facteurs.
object[] | null
requis
Actions que le propriétaire du compte doit effectuer pour débloquer des fonctionnalités comme les versements et les dépenses par carte, triées par priorité d’affichage. Calculé uniquement sur retrieve et me pour les appelants disposant de la portée company:balance:read ; null sinon.

Propriétés

string
requis
Ce que le titulaire doit faire ; de nouvelles valeurs peuvent être ajoutées, gérez donc les actions inconnues de manière appropriéeOptions disponibles : deposit_funds, review_held_payments, submit_information_request, update_automatic_withdrawal_method, reauthorize_payout_methods, update_payout_method, update_payout_profile, card_usage_review, verify_identity, scale_account_setup, sign_formation_documents, configure_tax_remitter, add_vat_registration, confirm_tax_details, accept_payout_terms, enable_two_factor_authentication, respond_to_abuse_report
string[]
requis
Fonctionnalités bloquées jusqu’à la résolution de ce point
string | null
requis
L’URL vers laquelle pointe l’appel à l’action, ou null lorsqu’il n’y a pas de bouton
string
requis
Libellé du bouton, ou vide lorsqu’il n’y a pas de bouton
string
requis
Texte d’accompagnement, ou vide
string | null
requis
L’URL de l’icône d’illustration de l’action, ou null si elle n’en a pas
string
requis
required (à traiter maintenant) ou pending (en cours d’examen)Options disponibles : required, pending
string
requis
Titre de l’action
object | null
requis
Le document de politique de retour du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
object[]
Récompenses professionnelles associées via le lien de parrainage actif de ce compte, avec la progression propre au compte et le statut du registre. Présent sur les réponses de retrieve ; vide sans accès en lecture à la fois au solde et aux statistiques.

Propriétés

string
requis
ID de la définition de récompense, préfixé par prwd_. La progression et le statut s’appliquent au compte qui la contient.
object
requis
Volume éligible en USD requis pour obtenir cette récompense.

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 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
requis
Volume éligible en USD pour l’activité de la récompense, cumulé par ce compte depuis l’attribution, calculé selon les règles d’exécution.

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 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
requis
Activité qui rend ce compte éligible à la récompense.Options disponibles : sales, ad_spend
object
requis
Montant en USD crédité pour cette récompense. Utilise le montant d’attribution enregistré une fois l’exécution commencée.

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 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
requis
L’état de la récompense de ce compte. Credited nécessite une écriture comptabilisée dans le registre ; processing inclut une condition remplie en attente d’exécution. Reversing et reversed reflètent une annulation ultérieure de la récompense.Options disponibles : in_progress, processing, credited, reversing, reversed, unavailable
string
requis
Identifiant de route public du compte.
boolean
requis
Indique si Whop envoie des e-mails transactionnels aux clients au nom de ce compte.
object | null
requis
Le document de politique d’expédition du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
boolean
requis
Indique si le compte apparaît dans les whops rejoints sur d’autres comptes.
boolean
requis
Indique si les avis sont affichés sur les pages produit en vente directe aux consommateurs.
boolean
requis
Indique si le compte affiche les utilisateurs dans l’annuaire des utilisateurs.
Liens sociaux du compte.

Propriétés

string
requis
L’ID du lien social
string | null
requis
Le titre d’affichage facultatif du lien social
string
requis
L’URL du lien social
string
requis
La plateforme sociale de ce lienOptions disponibles : x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom
string | null
requis
Indique si le compte peut opérer sur Whop : active ou suspended. Calculé sur list, retrieve, me et suspend ; null sinon.
string | null
requis
Raison de la suspension du compte, sous forme de libellé tel que Suspended - Fraudulent activity. Suspended lorsqu’aucune raison n’est enregistrée. Calculé sur retrieve, me et suspend. null sinon, ou lorsque status n’est pas suspended.
object
requis
Configuration d’affichage de la page boutique du compte.

Propriétés

string | null
requis
Couleur d’accent utilisée sur la page boutique du compte.Options disponibles : ruby, tomato, red, crimson, pink, plum, purple, violet, iris, cyan, teal, jade, green, grass, brown, blue, orange, indigo, sky, mint, yellow, amber, lime, lemon, magenta, gold, bronze, gray
string | null
requis
Mise en page utilisée sur la page boutique du compte.Options disponibles : featured, compact
string | null
requis
Présentation du profil utilisée sur la page boutique du compte.Options disponibles : personal, business
Indique si la page boutique du compte affiche un lien d’affiliation Whop.
string | null
requis
Public cible de ce compte.
string[]
requis
Codes des États américains (parmi les 50 États plus DC) où le compte collecte les taxes : l’ensemble complet lorsque Whop reverse les taxes (tax_remitted_by whop), le sous-ensemble configuré lorsque le compte les reverse lui-même (self), et vide dans les autres cas. Lors d’une mise à jour, envoyez la liste complète pour la remplacer (autorisé uniquement avec self).
object[]
requis
Immatriculations fiscales/TVA du compte. Vide lorsqu’aucune n’est définie.

Propriétés

string
requis
ID de l’identifiant fiscal.
string
requis
Type d’identifiant fiscal.Options disponibles : ad_nrt, ao_tin, ar_cuit, al_tin, am_tin, aw_tin, au_abn, au_arn, eu_vat, az_tin, bs_tin, bh_vat, bd_bin, bb_tin, by_tin, bj_ifu, bo_tin, ba_tin, br_cnpj, br_cpf, bg_uic, bf_ifu, kh_tin, cm_niu, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cv_nif, cl_tin, cn_tin, co_nit, cd_nif, cr_tin, hr_oib, do_rcn, ec_ruc, eg_tin, sv_nit, et_tin, eu_oss_vat, ge_vat, gh_tin, de_stn, gb_vat, gn_nif, hk_br, hu_tin, is_vat, in_gst, id_npwp, il_vat, jp_cn, jp_rn, jp_trn, kz_bin, ke_pin, kg_tin, la_tin, li_uid, li_vat, my_frp, my_itn, my_sst, mr_nif, mx_rfc, md_vat, me_pib, ma_vat, np_pan, nz_gst, ng_tin, mk_vat, no_vat, no_voec, om_vat, pe_ruc, ph_tin, pl_nip, ro_tin, ru_inn, ru_kpp, sa_vat, sn_ninea, rs_pib, sg_gst, sg_uen, si_tin, za_vat, kr_brn, es_cif, ch_uid, ch_vat, tw_vat, tj_tin, tz_vat, th_vat, tr_tin, ug_tin, ua_vat, ae_trn, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, zm_tin, zw_tin, sr_fin, xi_vat
string
requis
Valeur de l’identifiant fiscal, par exemple DE123456789. Consultez le guide des identifiants fiscaux.
string | null
requis
Qui calcule et reverse les taxes pour le compte. whop signifie que Whop calcule et reverse. self signifie que Whop calcule, et que le compte collecte et reverse. none signifie ni l’un ni l’autre, et le compte en est responsable. Les nouvelles entreprises commencent avec whop, et les nouveaux comptes connectés avec none. null signifie que le compte n’a encore aucun paramètre.Options disponibles : whop, self, none
string | null
requis
Comment les taxes sont appliquées aux prix du compte : inclusive (taxes incluses dans le prix affiché) ou exclusive (taxes ajoutées en sus). Vaut exclusive par défaut lorsqu’il n’est pas défini ; null uniquement lorsque le compte n’a aucune connexion de paiement.Options disponibles : inclusive, exclusive
object | null
requis
Le document de conditions d’utilisation du compte, ou null s’il n’en a pas publié.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il est indisponible ou supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Le nom du fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement à la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présents uniquement à la création.
string
requis
L’étape du cycle de vie de téléversement où se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle est indisponible ou supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle est indisponible ou supprimée par la modération.
string | null
requis
Comportement 3D Secure pour les paiements par carte en session pris en charge. mandate_challenge exige un challenge 3DS avant le traitement du paiement ; mandate_if_required impose un challenge uniquement lorsque le processeur de paiement l’exige ; frictionless_if_required utilise le flux 3DS sans friction habituel. Les paiements de 1 000 $ ou plus utilisent mandate_if_required sauf si mandate_challenge est sélectionné. Les exigences de risque et de reprise d’authentification peuvent prévaloir sur cette préférence. null utilise le flux de checkout standard.Options disponibles : mandate_challenge, mandate_if_required, frictionless_if_required
string
requis
Nom d’affichage du compte.
number | null
requis
Ventes du compte sur toute sa durée de vie, normalisées en USD. Calculé uniquement sur retrieve et me pour les appelants disposant de la portée stats:read ; null sinon.
string | null
requis
Valeur totale en USD de l’ensemble des soldes dont le taux de change est connu. Calculé uniquement sur les lectures d’un seul compte (retrieve et me) ; null sur les réponses de liste, les écritures, en l’absence d’autorisation de lecture du solde, ou lorsque la source du solde est indisponible.
trading_account | null
requis
L’adresse du compte de trading, un instantané de sa marge et de ses positions ouvertes, ainsi que ses abonnements WebSocket. Activez-le avec include_trading=true sur les lectures d’un seul compte. null sinon, sans autorisation de trading, ou sans portefeuille Ethereum.

Propriétés

string
requis
L’ID du portefeuille Whop associé à ce compte de trading, préfixé par cwal_.
string | null
requis
Le compte qui possède ce compte de trading, préfixé par biz_. null lorsqu’il appartient à un utilisateur.
object | null
requis
État propre à Hyperliquid. Présent lorsque provider vaut hyperliquid, null sinon.

Propriétés

string
requis
Adresse de portefeuille en minuscules qui détient le compte Hyperliquid.
string | null
requis
USDT0 dans le portefeuille Whop sur Plasma qu’une transaction deposit peut transférer vers ce compte, sous forme de chaîne décimale. null lorsque la chaîne n’a pas pu être lue.
object | null
requis
Valeur du compte et marge sur la plateforme d’échange principale et les marchés xyz, lues depuis Hyperliquid au plus une fois par seconde. null lorsque Hyperliquid n’a pas pu être lu. Utilisez websocket_subscriptions pour les mises à jour en direct.

Propriétés

object
requis
Valeur totale du compte en USD, y compris les profits et pertes latents.

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 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
requis
Marge allouée aux positions ouvertes, en USD.

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 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
requis
Valeur notionnelle cumulée des positions ouvertes, en USD.

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 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
requis
Montant en USD pouvant être retiré immédiatement sans clôturer de positions.

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 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.
trading_position[] | null
requis
Positions perpétuelles ouvertes sur la plateforme d’échange principale et les marchés xyz, lues depuis Hyperliquid au plus une fois par seconde. null lorsque Hyperliquid n’a pas pu être lu. Utilisez websocket_subscriptions pour les mises à jour en direct.

Propriétés

string
requis
ID de la position de trading, préfixé par trdpos_. Stable pour un marché au sein d’un même compte de trading.
object | null
requis
Prix d’entrée moyen en USD, ou null lorsque le fournisseur l’omet.

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 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
Détails des contrats perpétuels Hyperliquid. Présent sur les positions Hyperliquid, null sinon.

Propriétés

object
requis
Frais de financement payés sur la position sur plusieurs périodes, en USD.

Propriétés

object | null
requis
Frais de financement payés sur ce marché sur tout l’historique du compte, en USD, ou null lorsqu’ils sont indisponibles.

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 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
Frais de financement payés depuis la dernière modification de la taille de la position, en USD, ou null lorsqu’ils sont indisponibles.

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 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
Frais de financement payés depuis l’ouverture de la position, en USD, ou null lorsqu’ils sont indisponibles.

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 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
requis
Mode de marge et multiplicateur de la position.

Propriétés

string
requis
cross partage la marge entre les positions. isolated limite la marge à cette position.Options disponibles : cross, isolated
integer
requis
Multiplicateur appliqué à la marge de la position, comme 10 pour 10x.
object | null
requis
Prix de liquidation estimé en USD, ou null lorsque Hyperliquid n’en indique aucun.

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 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
requis
Marge allouée à la position, en USD.

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 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
requis
Rendement des capitaux propres sous forme de chaîne de ratio décimal, comme 0.1 pour 10 %.
string
requis
Symbole du marché chez le fournisseur, comme ETH.
string
requis
object
requis
Valeur actuelle de la position en USD.

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 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
requis
Options disponibles : long, short
string
requis
Taille absolue de la position sous forme de chaîne décimale.
object
requis
Profit ou perte latent en USD. Négatif en cas de perte.

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 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[]
requis
Abonnements pour les mises à jour du compte en direct. Envoyez chaque message tel quel après vous être connecté à websocket_url.

Propriétés

string
requis
Le flux de mises à jour en direct que cet abonnement ouvre.Options disponibles : clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
requis
Message d’abonnement JSON à envoyer tel quel via le WebSocket Hyperliquid.
string
requis
URL WebSocket Hyperliquid à laquelle se connecter directement pour les mises à jour en direct.
string
requis
string
requis
Plateforme de trading qui détient les positions et les ordres.Options disponibles : hyperliquid
object | null
requis
Avoirs spot dans le portefeuille Whop avec leur prix d’entrée et leurs profits et pertes. null lorsqu’ils n’ont pas pu être lus.

Propriétés

object[]
requis
Chaque actif spot encore détenu par le portefeuille, avec son prix d’entrée moyen et ses profits et pertes. Le prix de revient considère les unités les plus anciennes comme vendues en premier et inclut les actifs arrivés depuis l’extérieur de Whop.

Propriétés

object | null
requis
Le prix moyen payé par unité encore détenue, en USD, en considérant les unités les plus anciennes comme vendues en premier. null lorsqu’il n’est pas connu.

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 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
requis
Le montant payé en USD pour les unités encore détenues.

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 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
requis
L’id du marché spot issu de GET /trades/markets, comme BTC, XAUT, ou le ticker d’une action tokenisée comme AAPL.
object
requis
Gains et pertes déjà réalisés par des ventes, en USD.

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 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
requis
La valeur des unités encore détenues moins leur cost_basis, en USD.

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 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
unrealized_pnl en pourcentage de cost_basis, où 2 signifie une hausse de 2 %. null lorsqu’il n’est pas connu.
string | null
requis
L’utilisateur qui possède ce compte de trading, préfixé par user_. null lorsqu’il appartient à un compte.
boolean
requis
Indique si le compte utilise son logo comme image Open Graph de secours.
object
requis
Statut de vérification d’identité du compte pour les profils individual (KYC) et business (KYB). Chacun vaut null jusqu’à sa création, puis un status parmi not_started, pending, manual_review, approved ou rejected.
number | null
requis
Volume traité par le compte au cours des 30 derniers jours (GMV issu des reçus payés), normalisé en USD. Calculé uniquement sur list pour les appelants disposant de stats:read sur le compte ; null sinon.
number | null
requis
Volume traité par le compte sur toute sa durée de vie — ventes plus transferts reçus — normalisé en USD. Calculé uniquement sur list pour les appelants disposant de stats:read sur le compte ; null sinon.
object | null
requis
Portefeuille crypto principal du compte, ou null si aucun n’a été provisionné.

Propriétés

string
requis
ID du portefeuille, préfixé par wallet_.
string
requis
L’adresse on-chain du portefeuille
string
requis
Le réseau blockchain sur lequel se trouve le portefeuilleOptions disponibles : solana, ethereum, bitcoin
string | null
requis
L’URL du site web professionnel du compte, ou null si aucune n’a été fournie. La définir ajoute également une entrée website à social_links.
string | null
Date à laquelle le compte a activé le mode Whop Partner, sous forme d’horodatage ISO 8601. Présent sur les lectures d’un seul compte et les réponses de mise à jour ; null jusqu’à ce que le compte active le mode Whop Partner en envoyant whop_partner_enabled: true lors d’une mise à jour.
Account

Types d’entreprises et secteurs

Trois champs classent les comptes : business_type, industry_group et industry_type. La taxonomie complète se trouve sur sa propre page :

Types d'entreprises et secteurs