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

# Adhésion

> Une adhésion représente une relation active entre un utilisateur et un produit. Elle suit l'accès de l'utilisateur, le statut de facturation et le calendrier de renouvellement.

> [!NOTE]
>
> Cette ressource a un successeur dans l'[API Whop](https://docs.whop.com/fr/api-reference/legacy/memberships/membership.md), l'API versionnée sur laquelle les nouvelles intégrations doivent s'appuyer. Cette page reste entièrement prise en charge.

```json Example theme={null}
{
	"cancel_at_period_end": true,
	"cancel_option": "too_expensive",
	"cancelation_status": "won_back",
	"canceled_at": "2023-12-01T05:00:00.401Z",
	"cancellation_reason": "I found a better alternative.",
	"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"custom_field_responses": [
		{
			"answer": "<string>",
			"id": "cfrp_xxxxxxxxxxxxx",
			"question": "<string>"
		}
	],
	"external_accounts": [
		{
			"external_id": "<string>",
			"platform": "<string>",
			"username": "<string>"
		}
	],
	"feedback_option": {
		"label": "<string>"
	},
	"formatted_renewal_price": "$25.00 / month",
	"id": "mem_xxxxxxxxxxxxxx",
	"initial_price_paid": "$25.00",
	"joined_at": "2023-12-01T05:00:00.401Z",
	"license_key": "A1B2C3-D4E5F6-G7H8I9",
	"manage_url": "https://whop.com/billing/manage/mem_abc123",
	"member": {
		"id": "mber_xxxxxxxxxxxxx"
	},
	"metadata": {},
	"payment_collection_paused": true,
	"plan": {
		"id": "plan_xxxxxxxxxxxxx",
		"metadata": {}
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"metadata": {},
		"title": "Pickaxe Analytics"
	},
	"promo_code": {
		"id": "promo_xxxxxxxxxxxx"
	},
	"renewal_period_end": "2023-12-01T05:00:00.401Z",
	"renewal_period_start": "2023-12-01T05:00:00.401Z",
	"status": "trialing",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"profile_pic": "<string>",
		"username": "johndoe42"
	}
}
```

**cancel\_at\_period\_end** `boolean` *required*

Indique si cette adhésion est configurée pour être annulée à la fin du cycle de facturation en cours. S'applique uniquement aux adhésions avec un plan récurrent.

**cancel\_option** `CancelOptions | null` *required*

La catégorie choisie pour expliquer l'annulation du membre (par exemple too\_expensive, switching, missing\_features).

Options disponibles : `too_expensive`, `switching`, `missing_features`, `technical_issues`, `bad_experience`, `unused`, `other`, `testing`

**cancelation\_status** `CancelationStatus | null` *required*

Indique si le client est en cours d'annulation, est parti ou a été reconquis. Null si l'adhésion n'a pas de motif d'annulation ou si son état d'annulation est indéterminé.

Options disponibles : `won_back`, `left`, `canceling`

**canceled\_at** `string\<date-time\> | null` *required*

Le moment où le client a lancé l'annulation de cette adhésion. Sous forme d'horodatage Unix. Null si l'adhésion n'a pas été annulée.

Exemple : `2023-12-01T05:00:00.401Z`

**cancellation\_reason** `string | null` *required*

Explication libre fournie par le client lors de l'annulation. Null si le client n'a pas indiqué de motif.

Exemple : `I found a better alternative.`

**checkout\_configuration\_id** `string | null` *required*

L'ID de la session/configuration de checkout ayant produit cette adhésion, le cas échéant. Utilisez-le pour relier les adhésions à la configuration de checkout qui les a créées.

Exemple : `ch_xxxxxxxxxxxxxxx`

**company** `object` *required*

L'entreprise à laquelle appartient cette adhésion.

**attributs enfants**

**id** `string` *required*

L'identifiant unique de l'entreprise.

Exemple : `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

Le nom d'affichage de l'entreprise présenté aux clients.

Exemple : `Pickaxe`

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création de l'adhésion.

Exemple : `2023-12-01T05:00:00.401Z`

**currency** `Currencies | null` *required*

Le code de devise ISO à trois lettres utilisé pour la facturation de cette adhésion. Null si l'adhésion est gratuite.

Options disponibles : `usd`, `sgd`, `inr`, `aud`, `brl`, `cad`, `dkk`, `eur`, `nok`, `gbp`, `sek`, `chf`, `hkd`, `huf`, `jpy`, `mxn`, `myr`, `pln`, `czk`, `nzd`, `aed`, `eth`, `ape`, `cop`, `ron`, `thb`, `bgn`, `idr`, `dop`, `php`, `try`, `krw`, `twd`, `vnd`, `pkr`, `clp`, `uyu`, `ars`, `zar`, `dzd`, `tnd`, `mad`, `kes`, `kwd`, `jod`, `all`, `xcd`, `amd`, `bsd`, `bhd`, `bob`, `bam`, `khr`, `crc`, `xof`, `egp`, `etb`, `gmd`, `ghs`, `gtq`, `gyd`, `ils`, `jmd`, `mop`, `mga`, `mur`, `mdl`, `mnt`, `nad`, `ngn`, `mkd`, `omr`, `pyg`, `pen`, `qar`, `rwf`, `sar`, `rsd`, `lkr`, `tzs`, `ttd`, `uzs`, `rub`, `btc`, `cny`, `usdt`, `kzt`, `awg`, `whop_usd`, `xau`, `hnl`

**custom\_field\_responses** `array\<object\>` *required*

Les réponses du client aux questions de checkout personnalisées configurées sur le produit au moment de l'achat.

**attributs enfants**

**answer** `string` *required*

La réponse donnée par l'utilisateur à la question ou au champ spécifique.

**id** `string` *required*

L'identifiant unique de la réponse au champ personnalisé.

Exemple : `cfrp_xxxxxxxxxxxxx`

**question** `string` *required*

La question posée par le champ personnalisé

**external\_accounts** `array\<object\> | null` *required*

Les comptes du membre sur des plateformes externes, comme Discord et Telegram. Vide lorsque le membre n'en a lié aucun. Null dans les webhooks.

**attributs enfants**

**external\_id** `string` *required*

L'ID utilisateur du membre sur la plateforme, par exemple un ID utilisateur Discord. Préfixé par la plateforme (`discord_\<external_id>`), il s'agit de la valeur `external_account` utilisée comme filtre par List Memberships.

**platform** `string` *required*

La plateforme sur laquelle se trouve le compte du membre : `discord` ou `telegram`.

**username** `string | null` *required*

Le nom d'utilisateur du membre sur la plateforme. Null lorsque Whop ne le connaît pas, par exemple pour une adhésion importée avec uniquement un ID Discord.

**feedback\_option** `object | null` *required*

Le motif d'annulation propre au compte choisi par le membre, tel qu'il l'a vu. `null` lorsque le membre a choisi une catégorie par défaut ou n'a donné aucun motif.

**attributs enfants**

**label** `string` *required*

Le libellé de l'option au moment où le membre l'a choisie. Renommer l'option ultérieurement ne le modifie pas.

**formatted\_renewal\_price** `string | null` *required*

Le prix de renouvellement récurrent de cette adhésion, formaté avec le symbole de devise et l'intervalle de facturation. Null si l'adhésion n'est pas récurrente.

Exemple : `$25.00 / month`

**id** `string` *required*

L'identifiant unique de l'adhésion.

Exemple : `mem_xxxxxxxxxxxxxx`

**initial\_price\_paid** `string` *required*

Le montant payé par le client lors du premier achat de cette adhésion, formaté avec le symbole de devise.

Exemple : `$25.00`

**joined\_at** `string\<date-time\> | null` *required*

Le moment où l'utilisateur a rejoint pour la première fois l'entreprise associée à cette adhésion. Sous forme d'horodatage Unix. Null si l'enregistrement du membre n'existe pas.

Exemple : `2023-12-01T05:00:00.401Z`

**license\_key** `string | null` *required*

La clé de licence logicielle associée à cette adhésion. Présente uniquement si le produit inclut une expérience Whop Software Licensing. Null sinon.

Exemple : `A1B2C3-D4E5F6-G7H8I9`

**manage\_url** `string | null` *required*

L'URL où le client peut consulter et gérer cette adhésion, y compris l'annulation et les changements de plan. Null si aucun enregistrement de membre n'existe.

Exemple : `https://whop.com/billing/manage/mem_abc123`

**member** `object | null` *required*

L'enregistrement de membre reliant l'utilisateur à l'entreprise pour cette adhésion. Null si l'enregistrement de membre n'a pas encore été créé.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du membre.

Exemple : `mber_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Paires clé-valeur personnalisées pour l'adhésion (couramment utilisées pour les licences logicielles, par exemple HWID). 50 clés maximum, 100 caractères par clé, 500 caractères par valeur de type chaîne.

**payment\_collection\_paused** `boolean` *required*

Indique si l'encaissement des paiements récurrents de cette adhésion est temporairement suspendu par l'entreprise.

**plan** `object` *required*

Le plan acheté par le client pour créer cette adhésion.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du plan.

Exemple : `plan_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Paires clé-valeur personnalisées stockées sur le plan. Incluses dans les payloads de webhook des événements de paiement et d'adhésion. 50 clés maximum, 100 caractères par clé, 500 caractères par valeur de type chaîne. Les clés réservées `custom_cta` et `custom_cta_url`, lorsqu'elles sont définies, remplacent l'appel à l'action de checkout du produit pour ce plan.

**product** `object` *required*

Le produit auquel cette adhésion donne accès.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du produit.

Exemple : `prod_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Paires clé-valeur personnalisées stockées sur le produit et incluses dans les payloads de webhook de paiement et d'adhésion. 50 clés maximum, 100 caractères par clé, 500 caractères par valeur de type chaîne.

**title** `string` *required*

Le nom d'affichage du produit présenté aux clients sur la page produit et dans les résultats de recherche.

Exemple : `Pickaxe Analytics`

**promo\_code** `object | null` *required*

Le code promotionnel actuellement appliqué à la facturation de cette adhésion. Null si aucun code promo n'est actif.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du code promo.

Exemple : `promo_xxxxxxxxxxxx`

**renewal\_period\_end** `string\<date-time\> | null` *required*

La fin de la période de facturation en cours pour cette adhésion récurrente. Sous forme d'horodatage Unix. Null si l'adhésion n'est pas récurrente.

Exemple : `2023-12-01T05:00:00.401Z`

**renewal\_period\_start** `string\<date-time\> | null` *required*

Le début de la période de facturation en cours pour cette adhésion récurrente. Sous forme d'horodatage Unix. Null si l'adhésion n'est pas récurrente.

Exemple : `2023-12-01T05:00:00.401Z`

**status** `MembershipStatus` *required*

Le statut actuel du cycle de vie de l'adhésion (par exemple active, trialing, past\_due, canceled, expired, completed).

Options disponibles : `trialing`, `active`, `past_due`, `completed`, `canceled`, `expired`, `unresolved`, `drafted`, `canceling`

**updated\_at** `string\<date-time\>` *required*

La date et l'heure de la dernière mise à jour de l'adhésion.

Exemple : `2023-12-01T05:00:00.401Z`

**user** `object | null` *required*

L'utilisateur propriétaire de cette adhésion. Null si le compte utilisateur a été supprimé.

**attributs enfants**

**email** `string | null` *required*

L'adresse e-mail de l'utilisateur. Nécessite la permission member:email:read pour y accéder. Null si non autorisé.

Exemple : `john.doe@example.com`

**id** `string` *required*

L'identifiant unique de l'utilisateur.

Exemple : `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

Le nom d'affichage de l'utilisateur visible sur son profil public.

Exemple : `John Doe`

**profile\_pic** `string` *required*

L'URL de la photo de profil de l'utilisateur. Utilisez profilePicture pour obtenir l'objet de pièce jointe complet.

**username** `string` *required*

Le nom d'utilisateur unique de l'utilisateur visible sur son profil public.

Exemple : `johndoe42`


## Related topics

- [Adhésions](https://docs.whop.com/fr/developer/guides/memberships.md)
- [Vérifier les droits d'accès](https://docs.whop.com/fr/developer/guides/ios/check-entitlements.md)
- [Migrer depuis les versions précédentes](https://docs.whop.com/fr/developer/api/migrate-from-previous-versions.md)
