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

# Memberships API

> Een Membership is de aankoop van een variant door een klant: het abonnement of de eenmalige toekenning die toegang geeft tot een product.

Het houdt de factureringsstatus bij (`active`, `trialing`, `past_due`, enzovoort), de huidige periode, openstaande annuleringen, aangepaste metadata en de softwarelicentiesleutel wanneer het product licenties bevat.

Gebruik de Memberships API om de lidmaatschappen van een account of je eigen lidmaatschappen weer te geven, er een op te halen via ID of licentiesleutel, een ontvanger uit te nodigen om lid te worden via een gratis variant, en de levenscyclus te beheren: direct of aan het einde van de periode annuleren, een geplande annulering terugdraaien, het innen van betalingen pauzeren en hervatten, toegang verlengen of opnieuw activeren, een promotiecode of affiliate toepassen, de verlengingsfrequentie wijzigen, toegang opnieuw synchroniseren, een overdrachtslink genereren en metadata bijwerken.

> [!NOTE]
>
> Vervangt de Legacy-resource [Memberships](https://docs.whop.com/nl/api-reference/memberships/membership). Bestaande Legacy-integraties blijven werken; zie [API-versies](https://docs.whop.com/nl/developer/api/versioning.md) voor de stabiliteitsgarantie.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Lidmaatschappen weergeven](https://docs.whop.com/nl/api-reference/memberships/list-memberships.md) | GET `/memberships` |
| [Lidmaatschap ophalen](https://docs.whop.com/nl/api-reference/memberships/retrieve-membership.md) | GET `/memberships/{id}` |
| [Promotiecode toepassen op lidmaatschap](https://docs.whop.com/nl/api-reference/memberships/apply-promo-code-to-membership.md) | POST `/memberships/{id}/apply_promo_code` |
| [Affiliate toewijzen aan lidmaatschap](https://docs.whop.com/nl/api-reference/memberships/assign-affiliate-to-membership.md) | POST `/memberships/{id}/assign_affiliate` |
| [Lidmaatschap annuleren](https://docs.whop.com/nl/api-reference/memberships/cancel-membership.md) | POST `/memberships/{id}/cancel` |
| [Lidmaatschap verlengen](https://docs.whop.com/nl/api-reference/memberships/extend-membership.md) | POST `/memberships/{id}/extend` |
| [Lidmaatschap pauzeren](https://docs.whop.com/nl/api-reference/memberships/pause-membership.md) | POST `/memberships/{id}/pause` |
| [Lidmaatschap opnieuw activeren](https://docs.whop.com/nl/api-reference/memberships/reactivate-membership.md) | POST `/memberships/{id}/reactivate` |
| [Lidmaatschap hervatten](https://docs.whop.com/nl/api-reference/memberships/resume-membership.md) | POST `/memberships/{id}/resume` |
| [Toegang tot lidmaatschap opnieuw synchroniseren](https://docs.whop.com/nl/api-reference/memberships/resync-membership-access.md) | POST `/memberships/{id}/resync_access` |
| [Lidmaatschap overdragen](https://docs.whop.com/nl/api-reference/memberships/transfer-membership.md) | POST `/memberships/{id}/transfer` |
| [Uitnodigen voor een lidmaatschap](https://docs.whop.com/nl/api-reference/memberships/invite-to-a-membership.md) | POST `/memberships/invite` |
| [Lidmaatschap bijwerken](https://docs.whop.com/nl/api-reference/memberships/update-membership.md) | PATCH `/memberships/{id}` |

## Attributen

**id** `string` *required*

Lidmaatschap-ID, met prefix `mem_`.

**account** `object` *required*

Het account (verkoper) waartoe dit lidmaatschap behoort.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Account-ID, met prefix `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL van de logoafbeelding van het account. `null` wanneer het account er geen heeft ingesteld.
>
> **route** `string` *required*
>
> Openbare route-identificatie van het account, gebruikt in het storefront-pad `whop.com/\{route}`.
>
> **title** `string` *required*
>
> Weergavenaam van het account.

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

De affiliatecommissie van het lidmaatschap. `null` zonder affiliate, zonder `affiliate:basic:read` op het account, en altijd in webhooks.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Affiliate-ID, met prefix `aff_`.
>
> **applies\_to\_payments** `string` *required*
>
> Of de commissie alleen over de eerste betaling van het lidmaatschap wordt uitbetaald of over al zijn betalingen.
>
> Beschikbare opties: `first_payment`, `all_payments`
>
> **commission\_amount** `object | null` *required*
>
> De commissie als vast bedrag in de valuta van het lidmaatschap, of `null` bij een percentage.
>
> > [accordion] Eigenschappen
> >
> > **amount** `string` *required*
> >
> > Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: `"10.00"` is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
> >
> > **currency** `string` *required*
> >
> > Drieletterige ISO 4217-valutacode, in kleine letters.
> >
> > **decimals** `integer` *required*
> >
> > Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
> >
> > **display\_decimals** `integer` *required*
> >
> > Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan `decimals`, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso's, dus is het `2` en `0`. Maak het getal hiermee op in je eigen locale.
>
> **commission\_percentage** `number | null` *required*
>
> De procentuele commissie in procentpunten, dus `20` betekent 20%, of `null` bij een vast bedrag.
>
> **commission\_source** `string` *required*
>
> Hoe het commissietarief is vastgesteld: `custom` voor een tarief dat voor deze affiliate is ingesteld, `member` voor het affiliatetarief voor leden van het plan of product, `global` voor het wereldwijde affiliatetarief van het product, of `marketplace` voor een doorverwijzing via de Whop-marketplace.
>
> Beschikbare opties: `custom`, `member`, `marketplace`, `global`
>
> **commission\_type** `string` *required*
>
> Of de commissie een percentage of een vast bedrag is.
>
> Beschikbare opties: `flat_fee`, `percentage`
>
> **enabled** `boolean` *required*
>
> Of dit lidmaatschap affiliatecommissies uitbetaalt. `false` betekent dat de affiliate op het lidmaatschap blijft staan maar niet langer wordt betaald.
>
> **user\_id** `string` *required*
>
> ID van de gebruiker van de affiliate, met prefix `user_`.

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

Aantal dagen tussen terugkerende afschrijvingen. `null` voor niet-verlengende lidmaatschappen of lidmaatschappen met meerdere verlengingsschema's.

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

Of het lidmaatschap is ingesteld om te worden geannuleerd wanneer de huidige factureringsperiode eindigt. Alleen relevant voor terugkerende varianten.

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

De categorie die het lid heeft gekozen als reden voor het annuleren. `null` wanneer er geen categorie is gekozen.

Beschikbare opties: `too_expensive`, `switching`, `missing_features`, `technical_issues`, `bad_experience`, `unused`, `other`, `testing`

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

Wanneer de annulering is aangevraagd, of wanneer het lidmaatschap is geannuleerd als er geen aanvraagtijdstip is vastgelegd, als ISO 8601-tijdstempel. `null` wanneer geen van beide is vastgelegd.

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

Vrije toelichting die bij het annuleren is gegeven. `null` wanneer er geen reden is opgegeven.

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

Hoe verlengingen worden geïnd. `charge_automatically` schrijft elke periode af van de opgeslagen betaalmethode; `send_invoice` mailt de koper elke periode een factuur. `null` wanneer niet ingesteld.

Beschikbare opties: `charge_automatically`, `send_invoice`

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

Wanneer het lidmaatschap is aangemaakt, als ISO 8601-tijdstempel.

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

Wanneer de huidige factureringsperiode wordt verlengd, of wanneer een niet-verlengend lidmaatschap verloopt, als ISO 8601-tijdstempel. `null` voor eenmalige aankopen zonder vervaldatum.

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

Wanneer de huidige factureringsperiode begon, als ISO 8601-tijdstempel. `null` wanneer er geen factureringsperiode is vastgelegd.

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

Wanneer de toegang eindigt voor een lidmaatschap met een vaste vervaldatum, als ISO 8601-tijdstempel. `null` wanneer het lidmaatschap geen vervaldatum heeft, zoals een verlengend lidmaatschap.

**external\_accounts** `object[] | null` *required*

De accounts van het lid op externe platforms, zoals Discord en Telegram. Leeg wanneer het lid er geen heeft gekoppeld. `null` in webhooks.

> [accordion] Eigenschappen
>
> **external\_id** `string` *required*
>
> De gebruikers-ID van het lid op het platform, zoals een Discord-gebruikers-ID. Met het platform als prefix (`discord_\<external_id>`) is het de `external_account`-waarde waarop List Memberships filtert.
>
> **platform** `string` *required*
>
> Het platform waarop het account van het lid staat.
>
> Beschikbare opties: `discord`, `telegram`
>
> **username** `string | null` *required*
>
> De gebruikersnaam van het lid op het platform. `null` wanneer Whop deze niet kent, zoals bij een lidmaatschap dat is geïmporteerd met alleen een Discord-ID.

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

De eigen annuleringsreden van het account die het lid heeft gekozen, zoals het lid die zag. `null` wanneer het lid een standaardcategorie heeft gekozen of geen reden heeft opgegeven.

> [accordion] Eigenschappen
>
> **label** `string` *required*
>
> Het label van de optie op het moment dat het lid deze koos. Het later hernoemen van de optie verandert dit niet.

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

De huidige vooruitbetaalde prijs van de variant, in de valuta van de variant. Een catalogusprijs, niet noodzakelijk wat de koper heeft betaald. `amount` is `"0.00"` wanneer de eerste afschrijving gratis is.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: `"10.00"` is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Drieletterige ISO 4217-valutacode, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan `decimals`, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso's, dus is het `2` en `0`. Maak het getal hiermee op in je eigen locale.

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

De softwarelicentiesleutel voor dit lidmaatschap. Alleen aanwezig wanneer het product een experience voor softwarelicenties bevat.

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

URL waar de koper kan inloggen om de facturering te beheren. `null` zonder ledenrecord of tenzij de aanroeper de koper is of `member:manage` op het account heeft.

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

De ledenrij van de aanroeper op het account. Alleen aanwezig wanneer het lidmaatschap van de aanroeper is; `null` bij leesbewerkingen aan de verkoperszijde.

> [accordion] Eigenschappen
>
> **access\_level** `string` *required*
>
> Waartoe het lid toegang heeft op het account: `customer` voor betalende leden, `admin` voor teamleden, `no_access` zodra elke toekenning is verlopen.
>
> Beschikbare opties: `no_access`, `admin`, `customer`
>
> **last\_accessed\_at** `string | null` *required*
>
> Wanneer het lid voor het laatst de content van het account heeft geopend, als ISO 8601-tijdstempel. `null` als dat nooit is gebeurd.
>
> **position** `number | null` *required*
>
> De sorteerpositie van het lid in de eigen accountlijst van de koper. `null` totdat die deze ordent.

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

Het ledenrecord van de koper op het account, met prefix `mber_`. `null` wanneer het lidmaatschap geen ledenrecord heeft, zoals een niet-geclaimd lidmaatschap.

**metadata** `object` *required*

Aangepaste sleutel-waardeparen die op het lidmaatschap zijn opgeslagen, vaak gebruikt voor softwarelicenties.

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

De meest recente levenscyclusgebeurtenis van het lidmaatschap, zoals `renewing_on` of `canceled_on`. Combineer dit met `most_recent_action_at`. `null` wanneer er niets is vastgelegd.

Beschikbare opties: `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*

Wanneer `most_recent_action` plaatsvond of gepland staat, als ISO 8601-tijdstempel. Een toekomstig tijdstip voor aankomende gebeurtenissen zoals `renewing_on`. `null` wanneer er geen actie is vastgelegd.

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

Het telefoonnummer van de koper dat voor dit lidmaatschap is vastgelegd, of `null`. Het nummer dat bij de checkout is verzameld (of geverifieerd) wanneer telefoonverzameling van de verkoper is ingeschakeld; valt terug op het accountnummer van de koper als die het met deze verkoper heeft gedeeld.

**product** `object` *required*

Het product waartoe dit lidmaatschap toegang geeft.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Product-ID, met prefix `prod_`.
>
> **logo\_url** `string | null` *required*
>
> URL van de logoafbeelding van het product. `null` wanneer het product geen logo heeft.
>
> **title** `string` *required*
>
> Weergavenaam van het product.

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

Het product waartoe dit lidmaatschap toegang geeft, met prefix `prod_`.

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

De promotiecode die korting geeft op dit lidmaatschap, met prefix `promo_`. `null` wanneer er geen is toegepast. Ingesteld bij de checkout of via Apply Promo Code to Membership.

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

De verlengingsprijs van de variant, in de valuta van de variant, na een eventuele promotiecode die nog van toepassing is. Een lidmaatschap dat in de lokale valuta van de koper wordt gefactureerd, wordt op elke factuurdatum deze prijs omgerekend tegen de wisselkoers in rekening gebracht. `null` voor niet-verlengende lidmaatschappen.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: `"10.00"` is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Drieletterige ISO 4217-valutacode, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan `decimals`, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso's, dus is het `2` en `0`. Maak het getal hiermee op in je eigen locale.

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

Betaalde termijnen die tot nu toe zijn geteld voor een lidmaatschap met gespreide betaling. `null` wanneer het lidmaatschap geen gespreide betaling heeft, of voordat de eerste termijn is geteld.

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

Termijnbetalingen die nodig zijn voordat het lidmaatschap stopt met factureren. `null` wanneer het lidmaatschap geen gespreide betaling heeft.

**status** `string` *required*

Factureringsstatus van het lidmaatschap. `active`/`trialing`-lidmaatschappen geven toegang; `past_due` is de respijtperiode na een mislukte betaling; `completed` eenmalige aankopen behouden toegang; `canceled`/`expired` niet.

Beschikbare opties: `trialing`, `active`, `past_due`, `completed`, `canceled`, `expired`, `unresolved`

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

Wanneer het lidmaatschap voor het laatst is gewijzigd, als ISO 8601-tijdstempel. Geeft de meest recente wijziging aan het lidmaatschap zelf weer, zodat je kunt afstemmen met webhook-herhalingen, replays en backfills.

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

De koper, met prefix `user_`. `null` wanneer de koper een ander bedrijf is of het lidmaatschap niet is geclaimd.

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

De variant die de koper heeft gekocht, met prefix `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/nl/api-reference/legacy/memberships/cancel-membership.md)
- [Transfer Membership](https://docs.whop.com/nl/api-reference/memberships/transfer-membership.md)
- [List memberships](https://docs.whop.com/nl/api-reference/legacy/memberships/list-memberships.md)
