> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# API Whop Partners

> Recommandez des entreprises sur Whop et percevez des revenus sur leur activité, avec un lien de parrainage et des gains consultables depuis l'API.

Vous percevez des revenus pendant toute la durée du parrainage, sur quatre sources de revenus distinctes. Un seul appel vous inscrit et renvoie votre lien. Tout le reste rend compte de ce que vous avez recommandé et de ce que vous avez gagné.

## 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](https://docs.whop.com/fr/developer/concepts.md).

## Inscription

[`POST /partners`](https://docs.whop.com/fr/api-reference/partners/enroll-as-a-whop-partner) 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](https://docs.whop.com/fr/developer/guides/permissions.md).

## 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.

| `income_source` | Votre part porte sur |
| - | - |
| `sales` | Le bénéfice de Whop sur les ventes de produits de l'entreprise |
| `ad_spend` | Les dépenses Whop Ads de l'entreprise |
| `transfer` | Le bénéfice de Whop sur les transferts de solde de la plateforme |
| `card_interchange` | Le bénéfice de Whop sur l'interchange des cartes |

Pour une entreprise conclue au profit d'une entreprise partenaire, ce taux appartient à l'équipe. [`GET /partners/businesses/:id`](https://docs.whop.com/fr/api-reference/partners/retrieve-a-referred-business) 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`](https://docs.whop.com/fr/api-reference/partners/list-referred-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`](https://docs.whop.com/fr/api-reference/partners/list-referred-business-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à.

| `status` | Signification |
| - | - |
| `awaiting_settlement` | La transaction sous-jacente n'est pas encore réglée |
| `pending` | Réglé, pas encore versé |
| `completed` | Versé |
| `canceled` | Annulé avant le versement, avec `cancelation_reason` |
| `reversed` | Récupéré après coup, avec `cancelation_reason` |

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`](https://docs.whop.com/fr/api-reference/partners/retrieve-the-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

> [card] [S'inscrire comme partenaire](https://docs.whop.com/fr/api-reference/partners/enroll-as-a-whop-partner.md)
>
> Un seul appel pour rejoindre le programme et obtenir votre lien de parrainage.

> [card] [Lister vos parrainages](https://docs.whop.com/fr/api-reference/partners/list-referred-businesses.md)
>
> Toutes les entreprises que vous avez amenées, avec leurs gains.

> [card] [Affiliés](https://docs.whop.com/fr/developer/guides/affiliates.md)
>
> Le suivi des parrainages au sein de vos propres produits.

> [card] [Référence Partners](https://docs.whop.com/fr/api-reference/partners/partner)
>
> Tous les endpoints partenaires, avec un playground.


## Related topics

- [API Partners](https://docs.whop.com/fr/api-reference/partners/partner.md)
- [Enroll as a Whop Partner](https://docs.whop.com/fr/api-reference/partners/enroll-as-a-whop-partner.md)
- [API Partner Referral Requests](https://docs.whop.com/fr/api-reference/partner-referral-requests/partner-referral-request.md)
