Ce que vous pouvez créer
- Un programme de parrainage que vous gérez vous-même, en partageant votre propre lien avec votre propre audience.
- Des rapports sur ce que vous avez recommandé : quelles entreprises et quels utilisateurs sont encore actifs, et ce que chacun génère.
- Des relevés de gains détaillés jusqu’à la transaction et au taux derrière chaque ligne.
- Une page publique de classement issue du classement des partenaires.
Objets principaux
Partenaire, entreprise recommandée, gain de partenaire. Chacun est défini dans Concepts clés.Inscription
POST /partners inscrit l’utilisateur appelant et rend ses entreprises partenaires éligibles aux gains. Il renvoie referral_link, l’URL à partager pour être crédité, et whop_partner_enabled_at. Une nouvelle inscription conserve la date d’inscription d’origine au lieu de la réinitialiser, ce qui permet de répéter l’appel sans risque.
Nécessite la permission partner:create. La lecture des parrainages et des gains nécessite partner:basic:read, et la liste des entreprises recommandées accepte aussi referral:basic:read. Consultez Permissions.
Sur quoi vous percevez des revenus
payout_percentages sur une entreprise recommandée indique votre taux par source de revenus sous forme de fraction : 0.3 signifie donc 30 %. Trois des quatre correspondent à une part du bénéfice brut de Whop. Les dépenses publicitaires font exception : il s’agit d’une part des dépenses elles-mêmes.
Pour une entreprise conclue au profit d’une entreprise partenaire, ce taux appartient à l’équipe.
GET /partners/businesses/:id renvoie aussi my_payout_percentages, votre propre part de chaque taux. Il s’agit du taux complet lorsque vous avez recommandé l’entreprise vous-même. Pour un accord d’entreprise partenaire, il s’agit de la part de votre équipe sur le taux. Un manager perçoit sa part moins celle de la personne placée sous lui, et un participant à l’accord perçoit sa part. La valeur est null lorsque vous ne percevez rien sur l’entreprise.
GET /partners/businesses liste tout ce que vous avez recommandé, du plus récent au plus ancien. Chaque entreprise partenaire porte un ID coma_, un status valant active ou removed, ainsi que referral_started_at et referral_expires_at.
earnings_usd et volume_usd sont des objets plutôt que de simples nombres. earnings_usd se décompose en completed, pending et total. volume_usd se décompose en attributed, awaiting_settlement et settled.
Consulter les gains
GET /partners/businesses/{id}/earnings détaille ce que Whop vous verse pour une entreprise. Chaque gain indique sa income_source, le transaction_amount_usd dont il provient et votre payout_percentage.
Les gains sont réglés avant d’être versés. commission_amount_usd et payout_percentage valent tous deux null jusque-là.
Lorsque les données existent,
financial_activity détaille les lignes de revenus et de coûts derrière la commission. La valeur est null pour les gains réglés avant que Whop n’enregistre ce détail.
Le classement
GET /partners/leaderboard classe les parrains selon leurs gains de partenaire. Le paramètre period accepte day, month, year, last_30_days ou all_time, et vaut all_time par défaut.
L’authentification est facultative. Les appelants anonymes obtiennent le classement dans leaders, et les appelants authentifiés obtiennent aussi leur propre position dans me, qui vaut null lorsque vous n’avez encore aucun gain de parrainage.
Pour aller plus loin
S'inscrire comme partenaire
Un seul appel pour rejoindre le programme et obtenir votre lien de parrainage.
Lister vos parrainages
Toutes les entreprises que vous avez amenées, avec leurs gains.
Affiliés
Le suivi des parrainages au sein de vos propres produits.
Référence Partners
Tous les endpoints partenaires, avec un playground.

