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

> Une Membership est l'achat d'une variante par un client : l'abonnement ou l'octroi ponctuel qui lui donne accès à un produit.

Elle suit l'état de facturation (`active`, `trialing`, `past_due`, etc.), la période en cours, les annulations en attente, les métadonnées personnalisées et la clé de licence logicielle lorsque le produit inclut une licence.

Utilisez l'API Memberships pour lister les abonnements d'un compte ou les vôtres, en récupérer un par ID ou par clé de licence, inviter un destinataire à rejoindre via une variante gratuite, et gérer le cycle de vie : annuler immédiatement ou en fin de période, revenir sur une annulation planifiée, suspendre et reprendre l'encaissement des paiements, prolonger ou réactiver l'accès, appliquer un code promo ou un affilié, modifier la fréquence de renouvellement, resynchroniser l'accès, générer un lien de transfert et mettre à jour les métadonnées.

> [!NOTE]
>
> Remplace la ressource Legacy [Memberships](https://docs.whop.com/fr/api-reference/memberships/membership). Les intégrations Legacy existantes continuent de fonctionner ; consultez [Versions de l'API](https://docs.whop.com/fr/developer/api/versioning.md) pour le contrat de stabilité.

## Endpoints

| Endpoint | Requête |
| - | - |
| [List Memberships](https://docs.whop.com/fr/api-reference/memberships/list-memberships.md) | GET `/memberships` |
| [Retrieve Membership](https://docs.whop.com/fr/api-reference/memberships/retrieve-membership.md) | GET `/memberships/{id}` |
| [Apply Promo Code to Membership](https://docs.whop.com/fr/api-reference/memberships/apply-promo-code-to-membership.md) | POST `/memberships/{id}/apply_promo_code` |
| [Assign Affiliate to Membership](https://docs.whop.com/fr/api-reference/memberships/assign-affiliate-to-membership.md) | POST `/memberships/{id}/assign_affiliate` |
| [Cancel Membership](https://docs.whop.com/fr/api-reference/memberships/cancel-membership.md) | POST `/memberships/{id}/cancel` |
| [Extend Membership](https://docs.whop.com/fr/api-reference/memberships/extend-membership.md) | POST `/memberships/{id}/extend` |
| [Pause Membership](https://docs.whop.com/fr/api-reference/memberships/pause-membership.md) | POST `/memberships/{id}/pause` |
| [Reactivate Membership](https://docs.whop.com/fr/api-reference/memberships/reactivate-membership.md) | POST `/memberships/{id}/reactivate` |
| [Resume Membership](https://docs.whop.com/fr/api-reference/memberships/resume-membership.md) | POST `/memberships/{id}/resume` |
| [Resync Membership Access](https://docs.whop.com/fr/api-reference/memberships/resync-membership-access.md) | POST `/memberships/{id}/resync_access` |
| [Transfer Membership](https://docs.whop.com/fr/api-reference/memberships/transfer-membership.md) | POST `/memberships/{id}/transfer` |
| [Invite to a Membership](https://docs.whop.com/fr/api-reference/memberships/invite-to-a-membership.md) | POST `/memberships/invite` |
| [Update Membership](https://docs.whop.com/fr/api-reference/memberships/update-membership.md) | PATCH `/memberships/{id}` |

## Attributs

**id** `string` *required*

ID de l'abonnement, préfixé par `mem_`.

**account** `object` *required*

Le compte (vendeur) auquel appartient cet abonnement.

> [accordion] Properties
>
> **id** `string` *required*
>
> ID du compte, préfixé par `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL de l'image du logo du compte. `null` lorsque le compte n'en a pas défini.
>
> **route** `string` *required*
>
> Identifiant de route publique du compte, utilisé dans le chemin de la vitrine `whop.com/\{route}`.
>
> **title** `string` *required*
>
> Nom d'affichage du compte.

**affiliate** `object | null` *required*

La commission d'affiliation de l'abonnement. `null` sans affilié, sans `affiliate:basic:read` sur le compte, et toujours dans les webhooks.

> [accordion] Properties
>
> **id** `string` *required*
>
> ID de l'affilié, préfixé par `aff_`.
>
> **applies\_to\_payments** `string` *required*
>
> Indique si la commission est versée uniquement sur le premier paiement de l'abonnement ou sur tous ses paiements.
>
> Options disponibles : `first_payment`, `all_payments`
>
> **commission\_amount** `object | null` *required*
>
> La commission forfaitaire dans la devise de l'abonnement, ou `null` pour un pourcentage.
>
> > [accordion] Properties
> >
> > **amount** `string` *required*
> >
> > 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.
> >
> > **currency** `string` *required*
> >
> > Code de devise ISO 4217 à trois lettres, en minuscules.
> >
> > **decimals** `integer` *required*
> >
> > Nombre de décimales que comporte le montant. Il s'agit de la précision à laquelle le débit lui-même est effectué.
> >
> > **display\_decimals** `integer` *required*
> >
> > 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.
>
> **commission\_percentage** `number | null` *required*
>
> La commission en pourcentage, exprimée en points de pourcentage, de sorte que `20` signifie 20 %, ou `null` pour un forfait.
>
> **commission\_source** `string` *required*
>
> La manière dont le taux de commission a été défini : `custom` pour un taux défini pour cet affilié, `member` pour le taux d'affiliation des membres du plan ou du produit, `global` pour le taux d'affiliation global du produit, ou `marketplace` pour un parrainage de la marketplace Whop.
>
> Options disponibles : `custom`, `member`, `marketplace`, `global`
>
> **commission\_type** `string` *required*
>
> Indique si la commission est un pourcentage ou un forfait.
>
> Options disponibles : `flat_fee`, `percentage`
>
> **enabled** `boolean` *required*
>
> Indique si cet abonnement verse des commissions d'affiliation. `false` signifie que l'affilié est conservé sur l'abonnement mais n'est plus rémunéré.
>
> **user\_id** `string` *required*
>
> ID de l'utilisateur de l'affilié, préfixé par `user_`.

**billing\_period\_days** `integer | null` *required*

Nombre de jours entre les débits récurrents. `null` pour les abonnements sans renouvellement ou ceux ayant plusieurs calendriers de renouvellement.

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

Indique si l'abonnement est configuré pour être annulé à la fin de la période de facturation en cours. Pertinent uniquement pour les variantes récurrentes.

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

La catégorie choisie par le membre pour expliquer son annulation. `null` lorsqu'aucune catégorie n'a été choisie.

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

**canceled\_at** `string | null` *required*

Date de la demande d'annulation, ou date d'annulation de l'abonnement si aucune date de demande n'est enregistrée, sous forme de timestamp ISO 8601. `null` lorsqu'aucune des deux n'est enregistrée.

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

Explication en texte libre fournie lors de l'annulation. `null` lorsqu'aucune raison n'a été fournie.

**collection\_method** `string | null` *required*

La manière dont les renouvellements sont encaissés. `charge_automatically` débite le moyen de paiement enregistré à chaque période ; `send_invoice` envoie une facture par e-mail à l'acheteur à chaque période. `null` lorsque non défini.

Options disponibles : `charge_automatically`, `send_invoice`

**created\_at** `string` *required*

Date de création de l'abonnement, sous forme de timestamp ISO 8601.

**current\_period\_end** `string | null` *required*

Date de renouvellement de la période de facturation en cours, ou date d'expiration d'un abonnement sans renouvellement, sous forme de timestamp ISO 8601. `null` pour les achats uniques sans expiration.

**current\_period\_start** `string | null` *required*

Date de début de la période de facturation en cours, sous forme de timestamp ISO 8601. `null` lorsqu'aucune période de facturation n'est enregistrée.

**expires\_at** `string | null` *required*

Date de fin de l'accès pour un abonnement à expiration fixe, sous forme de timestamp ISO 8601. `null` lorsque l'abonnement n'a pas d'expiration, comme un abonnement renouvelable.

**external\_accounts** `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.

> [accordion] Properties
>
> **external\_id** `string` *required*
>
> L'ID utilisateur du membre sur la plateforme, comme un ID utilisateur Discord. Préfixé par la plateforme (`discord_\<external_id>`), c'est la valeur `external_account` sur laquelle filtre List Memberships.
>
> **platform** `string` *required*
>
> La plateforme sur laquelle se trouve le compte du membre.
>
> Options disponibles : `discord`, `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 un abonnement importé avec uniquement un ID Discord.

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

La raison d'annulation propre au compte choisie par le membre, telle qu'il l'a vue. `null` lorsque le membre a choisi une catégorie par défaut ou n'a donné aucune raison.

> [accordion] Properties
>
> **label** `string` *required*
>
> Le libellé de l'option au moment où le membre l'a choisie. Renommer l'option par la suite ne le modifie pas.

**initial\_price** `object` *required*

Le prix initial actuel de la variante, dans la devise de la variante. Il s'agit d'un prix catalogue, pas nécessairement de ce que l'acheteur a payé. `amount` vaut `"0.00"` lorsque le premier débit est gratuit.

> [accordion] Properties
>
> **amount** `string` *required*
>
> 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.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision à laquelle le débit lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> 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.

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

La clé de licence logicielle de cet abonnement. Présente uniquement lorsque le produit inclut une expérience de licence logicielle.

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

URL où l'acheteur peut se connecter pour gérer sa facturation. `null` sans enregistrement de membre ou sauf si l'appelant est l'acheteur ou dispose de `member:manage` sur le compte.

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

L'enregistrement de membre de l'appelant sur le compte. Présent uniquement lorsque l'abonnement appartient à l'appelant ; `null` pour les lectures côté vendeur.

> [accordion] Properties
>
> **access\_level** `string` *required*
>
> Ce à quoi le membre peut accéder sur le compte : `customer` pour les membres payants, `admin` pour les membres de l'équipe, `no_access` une fois que tous les accès ont expiré.
>
> Options disponibles : `no_access`, `admin`, `customer`
>
> **last\_accessed\_at** `string | null` *required*
>
> Date à laquelle le membre a ouvert le contenu du compte pour la dernière fois, sous forme de timestamp ISO 8601. `null` s'il ne l'a jamais fait.
>
> **position** `number | null` *required*
>
> La position de tri du membre dans la liste de comptes de l'acheteur. `null` jusqu'à ce qu'il l'organise.

**member\_id** `string | null` *required*

L'enregistrement de membre de l'acheteur sur le compte, préfixé par `mber_`. `null` lorsque l'abonnement n'a pas d'enregistrement de membre, comme un abonnement non réclamé.

**metadata** `object` *required*

Paires clé-valeur personnalisées stockées sur l'abonnement, couramment utilisées pour les licences logicielles.

**most\_recent\_action** `string | null` *required*

Le dernier événement du cycle de vie de l'abonnement, comme `renewing_on` ou `canceled_on`. À associer à `most_recent_action_at`. `null` lorsqu'aucun n'est enregistré.

Options disponibles : `canceled_on`, `finished_split_pay_at`, `canceling_on`, `ending_on`, `renewing_on`, `past_due`, `next_payment_attempt`, `paused_at`, `trial_ends_at`, `unresolved_at`, `trial_canceling_on`

**most\_recent\_action\_at** `string | null` *required*

Date à laquelle `most_recent_action` a eu lieu ou est planifié, sous forme de timestamp ISO 8601. Une date future pour les événements à venir comme `renewing_on`. `null` lorsqu'aucune action n'est enregistrée.

**phone\_number** `string | null` *required*

Le numéro de téléphone de l'acheteur enregistré pour cet abonnement, ou `null`. Le numéro collecté (ou vérifié) lors du checkout lorsque la collecte du téléphone par le vendeur est activée ; sinon, le numéro du compte de l'acheteur lorsqu'il l'a partagé avec ce vendeur.

**product** `object` *required*

Le produit auquel cet abonnement donne accès.

> [accordion] Properties
>
> **id** `string` *required*
>
> ID du produit, préfixé par `prod_`.
>
> **logo\_url** `string | null` *required*
>
> URL de l'image du logo du produit. `null` lorsque le produit n'a pas de logo.
>
> **title** `string` *required*
>
> Nom d'affichage du produit.

**product\_id** `string` *required*

Le produit auquel cet abonnement donne accès, préfixé par `prod_`.

**promo\_code\_id** `string | null` *required*

Le code promo appliquant une remise à cet abonnement, préfixé par `promo_`. `null` lorsqu'aucun n'est appliqué. Défini lors du checkout ou par Apply Promo Code to Membership.

**renewal\_price** `object | null` *required*

Le prix de renouvellement de la variante, dans la devise de la variante, après application de tout code promo encore valable. Un abonnement facturé dans la devise locale de l'acheteur est débité de ce prix converti au taux de change à chaque date de facturation. `null` pour les abonnements sans renouvellement.

> [accordion] Properties
>
> **amount** `string` *required*
>
> 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.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision à laquelle le débit lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> 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.

**split\_pay\_current\_payments** `integer | null` *required*

Échéances payées comptabilisées jusqu'à présent sur un abonnement en paiement fractionné. `null` lorsque l'abonnement n'est pas en paiement fractionné, ou avant que sa première échéance ne soit comptabilisée.

**split\_pay\_required\_payments** `integer | null` *required*

Échéances de paiement requises avant que l'abonnement cesse d'être facturé. `null` lorsque l'abonnement n'est pas en paiement fractionné.

**status** `string` *required*

État de facturation de l'abonnement. Les abonnements `active`/`trialing` donnent accès ; `past_due` correspond à la période de grâce après un paiement échoué ; les achats uniques `completed` conservent l'accès ; `canceled`/`expired` non.

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

**updated\_at** `string` *required*

Date de la dernière modification de l'abonnement, sous forme de timestamp ISO 8601. Reflète la modification la plus récente de l'abonnement lui-même, ce qui vous permet d'effectuer un rapprochement avec les nouvelles tentatives, rejeux et backfills de webhooks.

**user\_id** `string | null` *required*

L'acheteur, préfixé par `user_`. `null` lorsque l'acheteur est une autre entreprise ou que l'abonnement n'est pas réclamé.

**variant\_id** `string` *required*

La variante achetée par l'acheteur, préfixée par `plan_`.

```json Membership theme={null}
{
	"id": "mem_xxxxxxxxxxxxxx",
	"affiliate": null,
	"status": "active",
	"collection_method": "charge_automatically",
	"most_recent_action": "renewing_on",
	"most_recent_action_at": "2026-08-01T00:00:00.000Z",
	"user_id": "user_xxxxxxxxxxxxx",
	"product_id": "prod_xxxxxxxxxxxxx",
	"variant_id": "plan_xxxxxxxxxxxxx",
	"member_id": "mber_xxxxxxxxxxxxx",
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Pro",
		"logo_url": "https://cdn.whop.com/product.png"
	},
	"initial_price": {
		"currency": "usd",
		"amount": "0.00",
		"decimals": 2,
		"display_decimals": 2
	},
	"renewal_price": {
		"currency": "usd",
		"amount": "50.00",
		"decimals": 2,
		"display_decimals": 2
	},
	"split_pay_current_payments": null,
	"split_pay_required_payments": null,
	"expires_at": null,
	"promo_code_id": null,
	"billing_period_days": 30,
	"license_key": "A1B2C3-D4E5F6-G7H8I9",
	"phone_number": "+12025550123",
	"cancel_at_period_end": false,
	"current_period_start": "2026-07-01T00:00:00.000Z",
	"current_period_end": "2026-08-01T00:00:00.000Z",
	"canceled_at": null,
	"cancel_option": null,
	"cancellation_reason": null,
	"feedback_option": null,
	"external_accounts": [
		{
			"platform": "discord",
			"external_id": "123456789012345678",
			"username": "jane"
		}
	],
	"manage_url": "https://whop.com/billing/manage/mber_xxxxxxxxxxxxx",
	"metadata": {
		"external_customer_id": "cus_123"
	},
	"created_at": "2026-07-01T00:00:00.000Z",
	"updated_at": "2026-07-15T00:00:00.000Z",
	"member": {
		"access_level": "customer",
		"last_accessed_at": "2026-07-20T15:30:00.000Z",
		"position": 1
	},
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe",
		"route": "pickaxe",
		"logo_url": "https://cdn.whop.com/account.png"
	}
}
```


## Related topics

- [Cancel membership](https://docs.whop.com/fr/api-reference/legacy/memberships/cancel-membership.md)
- [List memberships](https://docs.whop.com/fr/api-reference/legacy/memberships/list-memberships.md)
- [Retrieve membership](https://docs.whop.com/fr/api-reference/legacy/memberships/retrieve-membership.md)
