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

# Lidmaatschap

> Een lidmaatschap vertegenwoordigt een actieve relatie tussen een gebruiker en een product. Het houdt de toegang, de factureringsstatus en het verlengingsschema van de gebruiker bij.

> [!NOTE]
>
> Deze resource heeft een opvolger in de [Whop API](https://docs.whop.com/nl/api-reference/legacy/memberships/membership.md), de geversioneerde API waarop nieuwe integraties moeten worden gebouwd. Deze pagina blijft volledig ondersteund.

```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*

Of dit lidmaatschap aan het einde van de huidige factureringscyclus wordt opgezegd. Alleen van toepassing op lidmaatschappen met een terugkerend plan.

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

De gekozen categorie voor de reden waarom het lid heeft opgezegd (bijv. too\_expensive, switching, missing\_features).

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

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

Of de klant aan het opzeggen is, is vertrokken of is teruggewonnen. Null als het lidmaatschap geen opzeggingsreden heeft of de opzeggingsstatus onbepaald is.

Beschikbare opties: `won_back`, `left`, `canceling`

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

Het tijdstip waarop de klant de opzegging van dit lidmaatschap heeft gestart. Als Unix-tijdstempel. Null als het lidmaatschap niet is opgezegd.

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

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

Vrije toelichting die de klant bij het opzeggen heeft gegeven. Null als de klant geen reden heeft opgegeven.

Voorbeeld: `I found a better alternative.`

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

De ID van de checkoutsessie/-configuratie waaruit dit lidmaatschap is voortgekomen, indien aanwezig. Gebruik dit om lidmaatschappen te herleiden naar de checkoutconfiguratie die ze heeft aangemaakt.

Voorbeeld: `ch_xxxxxxxxxxxxxxx`

**company** `object` *required*

Het bedrijf waartoe dit lidmaatschap behoort.

**onderliggende attributen**

**id** `string` *required*

De unieke identificatie van het bedrijf.

Voorbeeld: `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

De weergavenaam van het bedrijf die aan klanten wordt getoond.

Voorbeeld: `Pickaxe`

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

De datum en tijd waarop het lidmaatschap is aangemaakt.

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

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

De driecijferige ISO-valutacode voor de facturering van dit lidmaatschap. Null als het lidmaatschap gratis is.

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

De antwoorden van de klant op aangepaste checkoutvragen die op het moment van aankoop voor het product waren ingesteld.

**onderliggende attributen**

**answer** `string` *required*

Het antwoord dat een gebruiker op de specifieke vraag of het specifieke veld heeft gegeven.

**id** `string` *required*

De unieke identificatie van het antwoord op het aangepaste veld.

Voorbeeld: `cfrp_xxxxxxxxxxxxx`

**question** `string` *required*

De vraag die door het aangepaste veld wordt gesteld

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

**onderliggende attributen**

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

De gebruikers-ID van het lid op het platform, zoals een Discord-gebruikers-ID. Voorafgegaan door het platform (`discord_\<external_id>`); dit is de `external_account`-waarde waarop List Memberships filtert.

**platform** `string` *required*

Het platform waarop het account van het lid staat: `discord` of `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 opzeggingsreden 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.

**onderliggende attributen**

**label** `string` *required*

Het label van de optie op het moment dat het lid die koos. Het later hernoemen van de optie verandert dit niet.

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

De terugkerende verlengingsprijs voor dit lidmaatschap, opgemaakt met valutasymbool en factureringsinterval. Null als het lidmaatschap niet terugkerend is.

Voorbeeld: `$25.00 / month`

**id** `string` *required*

De unieke identificatie van het lidmaatschap.

Voorbeeld: `mem_xxxxxxxxxxxxxx`

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

Het bedrag dat de klant bij de eerste aankoop van dit lidmaatschap heeft betaald, opgemaakt met valutasymbool.

Voorbeeld: `$25.00`

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

Het tijdstip waarop de gebruiker zich voor het eerst heeft aangesloten bij het bedrijf dat bij dit lidmaatschap hoort. Als Unix-tijdstempel. Null als het lidrecord niet bestaat.

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

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

De softwarelicentiesleutel die bij dit lidmaatschap hoort. Alleen aanwezig als het product een Whop Software Licensing-experience bevat. Anders null.

Voorbeeld: `A1B2C3-D4E5F6-G7H8I9`

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

De URL waar de klant dit lidmaatschap kan bekijken en beheren, inclusief opzeggen en planwijzigingen. Null als er geen lidrecord bestaat.

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

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

Het lidrecord dat de gebruiker voor dit lidmaatschap aan het bedrijf koppelt. Null als het lidrecord nog niet is aangemaakt.

**onderliggende attributen**

**id** `string` *required*

De unieke identificatie van het lid.

Voorbeeld: `mber_xxxxxxxxxxxxx`

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

Aangepaste sleutel-waardeparen voor het lidmaatschap (vaak gebruikt voor softwarelicenties, bijv. HWID). Maximaal 50 sleutels, 100 tekens per sleutel, 500 tekens per tekenreekswaarde.

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

Of het innen van terugkerende betalingen voor dit lidmaatschap tijdelijk door het bedrijf is gepauzeerd.

**plan** `object` *required*

Het plan dat de klant heeft gekocht om dit lidmaatschap aan te maken.

**onderliggende attributen**

**id** `string` *required*

De unieke identificatie van het plan.

Voorbeeld: `plan_xxxxxxxxxxxxx`

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

Aangepaste sleutel-waardeparen die op het plan zijn opgeslagen. Opgenomen in webhook-payloads voor betalings- en lidmaatschapsevents. Maximaal 50 sleutels, 100 tekens per sleutel, 500 tekens per tekenreekswaarde. De gereserveerde sleutels `custom_cta` en `custom_cta_url` overschrijven, indien ingesteld, de checkout-call-to-action van het product voor dit plan.

**product** `object` *required*

Het product waartoe dit lidmaatschap toegang geeft.

**onderliggende attributen**

**id** `string` *required*

De unieke identificatie van het product.

Voorbeeld: `prod_xxxxxxxxxxxxx`

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

Aangepaste sleutel-waardeparen die op het product zijn opgeslagen en worden opgenomen in webhook-payloads voor betalingen en lidmaatschappen. Maximaal 50 sleutels, 100 tekens per sleutel, 500 tekens per tekenreekswaarde.

**title** `string` *required*

De weergavenaam van het product die aan klanten wordt getoond op de productpagina en in zoekresultaten.

Voorbeeld: `Pickaxe Analytics`

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

De promotiecode die momenteel op de facturering van dit lidmaatschap wordt toegepast. Null als er geen promotiecode actief is.

**onderliggende attributen**

**id** `string` *required*

De unieke identificatie van de promotiecode.

Voorbeeld: `promo_xxxxxxxxxxxx`

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

Het einde van de huidige factureringsperiode voor dit terugkerende lidmaatschap. Als Unix-tijdstempel. Null als het lidmaatschap niet terugkerend is.

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

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

Het begin van de huidige factureringsperiode voor dit terugkerende lidmaatschap. Als Unix-tijdstempel. Null als het lidmaatschap niet terugkerend is.

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

**status** `MembershipStatus` *required*

De huidige levenscyclusstatus van het lidmaatschap (bijv. active, trialing, past\_due, canceled, expired, completed).

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

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

De datum en tijd waarop het lidmaatschap voor het laatst is bijgewerkt.

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

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

De gebruiker die eigenaar is van dit lidmaatschap. Null als het gebruikersaccount is verwijderd.

**onderliggende attributen**

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

Het e-mailadres van de gebruiker. Vereist de machtiging member:email:read. Null als er geen toestemming is.

Voorbeeld: `john.doe@example.com`

**id** `string` *required*

De unieke identificatie van de gebruiker.

Voorbeeld: `user_xxxxxxxxxxxxx`

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

De weergavenaam van de gebruiker die op diens openbare profiel wordt getoond.

Voorbeeld: `John Doe`

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

De URL van de profielfoto van de gebruiker. Gebruik profilePicture voor het volledige bijlageobject.

**username** `string` *required*

De unieke gebruikersnaam van de gebruiker die op diens openbare profiel wordt getoond.

Voorbeeld: `johndoe42`


## Related topics

- [Lidmaatschappen](https://docs.whop.com/nl/developer/guides/memberships.md)
- [Migreren vanaf eerdere versies](https://docs.whop.com/nl/developer/api/migrate-from-previous-versions.md)
- [Rechten controleren](https://docs.whop.com/nl/developer/guides/ios/check-entitlements.md)
