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

# Variants API

> Een Variant is één koopbare configuratie van een product.

Deze bepaalt prijs, factureringsritme, voorraad, SKU, attributen, belastinggedrag, checkoutvelden en zichtbaarheid bij aankoop. Variant-ID's hebben nog steeds de prefix `plan_`.

Gebruik de Variants API om varianten voor producten aan te maken, bestaande varianten op te vragen, variantconfiguratie op te halen of bij te werken, belasting voor de checkout te berekenen en varianten te verwijderen die niet langer moeten worden aangeboden.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Variants opvragen](https://docs.whop.com/nl/api-reference/variants/list-variants.md) | GET `/variants` |
| [Variant ophalen](https://docs.whop.com/nl/api-reference/variants/retrieve-variant.md) | GET `/variants/{id}` |
| [Variant aanmaken](https://docs.whop.com/nl/api-reference/variants/create-variant.md) | POST `/variants` |
| [Variant bijwerken](https://docs.whop.com/nl/api-reference/variants/update-variant.md) | PATCH `/variants/{id}` |
| [Variant verwijderen](https://docs.whop.com/nl/api-reference/variants/delete-variant.md) | DELETE `/variants/{id}` |

## Attributen

**id** `string` *required*

Variant-ID, met prefix `plan_`.

**account** `object | null` *required*

Account dat deze variant verkoopt; `null` voor zelfstandige factuurvarianten.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Account-ID, met prefix `biz_`.
>
> **title** `string` *required*
>
> Weergavenaam van het account.

**adaptive\_pricing\_enabled** `boolean` *required*

Of adaptieve prijsstelling is ingeschakeld voor deze variant. Ruwe instelling — controleert geen compatibiliteit met de verwerker of feature flags.

**allow\_multiple\_quantity** `boolean` *required*

Of er meer dan één eenheid in een bestelling kan worden gekocht. Verlengingsvarianten kunnen dit niet inschakelen. Wanneer `false`, weigeren checkouts, winkelwagens en facturen een hoeveelheid boven 1.

**attributes** `object | null` *required*

Attribuutwaarden die deze variant binnen het product onderscheiden, als een map van attribuutnaam naar waarde, bijv. `\{"color": "Blue", "size": "Large"}`. Namen zijn snake\_case-identifiers en worden in alfabetische volgorde geretourneerd. Elke variant met attributen binnen een product heeft dezelfde attribuutnamen en een unieke set waarden; het product vermeldt de volledige set opties als `variant_attributes`. `null` wanneer de variant geen attributen heeft.

**billing\_period** `number | null` *required*

Aantal dagen tussen terugkerende afschrijvingen, zoals 30 voor maandelijks of 365 voor jaarlijks. `null` voor eenmalige varianten.

**billing\_type** `string` *required*

Factureringsmodel voor deze variant.

Beschikbare opties: `renewal`, `one_time`

**cancel\_discount\_intervals** `number | null` *required*

Hoe lang de annuleringskorting geldt: `0` voor altijd, `1` alleen voor de volgende betaling, of een aantal kalendermaanden vanaf het moment dat de klant deze accepteert. `null` wanneer er geen wordt aangeboden of de actor de scope `plan:basic:read` niet heeft.

**cancel\_discount\_percentage** `number | null` *required*

Annuleringskorting als percentage in hele getallen. `null` wanneer er geen wordt aangeboden of de actor de scope `plan:basic:read` niet heeft.

**checkout\_styling** `object | null` *required*

Checkoutstyling op variantniveau (`background_color`, `button_color`, `font_family`, `border_style`); `null` neemt de standaard van het account over.

**collect\_tax** `boolean` *required*

Of er belasting wordt geïnd bij aankopen van deze variant, op basis van de belastingconfiguratie van het account.

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

Wanneer de variant is aangemaakt, als ISO 8601-tijdstempel.

**currency** `string` *required*

Driecijferige ISO 4217-code van de valuta waarin elke prijs op deze variant is uitgedrukt, in kleine letters: de eigen valuta van de variant, of de `presentment_currency` waarom bij het lezen is gevraagd wanneer de variant daarnaar kan worden omgerekend.

**custom\_fields** `object[]` *required*

Aangepaste invoervelden die op het checkoutformulier worden verzameld.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> ID van het aangepaste veld, met prefix `field_`.
>
> **field\_type** `string` *required*
>
> Invoertype van het aangepaste veld.
>
> Beschikbare opties: `text`
>
> **name** `string` *required*
>
> Veldlabel dat bij de checkout aan de klant wordt getoond.
>
> **order** `number` *required*
>
> Positie van het veld op het checkoutformulier.
>
> **placeholder** `string | null` *required*
>
> Placeholdertekst die in het lege veld wordt getoond. `null` als er geen is ingesteld.
>
> **required** `boolean` *required*
>
> Of de klant dit veld moet invullen om af te rekenen.

**deletable** `boolean | null` *required*

Of de variant kan worden verwijderd (er zijn geen memberships of wachtlijstinschrijvingen). `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

**description** `string | null` *required*

Voor de klant zichtbare variantbeschrijving. Maximaal 1000 tekens. `null` als er geen beschrijving is ingesteld.

**effective\_payment\_method\_configuration** `object | null` *required*

De configuratie die een checkout voor deze variant bepaalt, opgelost via elke laag (die van de variant zelf en die van het account) — de vorm die de `payment_method_configuration` van een sessie heeft. Pas deze toe op de catalogus van betaalmethodetypes voor de aan te bieden set. `null` betekent platformstandaarden; `payment_method_configuration` blijft de eigen bewerkbare override van de variant.

> [accordion] Eigenschappen
>
> **disabled** `string[]` *required*
>
> Betaalmethoden die deze checkout achterhoudt, zelfs wanneer de standaarden ze zouden aanbieden.
>
> **enabled** `string[]` *required*
>
> Betaalmethoden die deze checkout aanbiedt bovenop wat de standaarden bieden.
>
> **include\_platform\_defaults** `boolean` *required*
>
> Of de standaardset van Whop het uitgangspunt is. Wanneer `false`, wordt alleen `enabled` aangeboden.

**expiration\_days** `number | null` *required*

Toegangsduur in dagen voor varianten met een vervaldatum, zoals 365 voor een jaarpas. `null` voor varianten zonder vervaldatum.

**formatted\_price** `string` *required*

Leesbare prijs voor weergave (valuta + interval) in `currency`, bijv. "\$10 / month".

**image** `object | null` *required*

Afbeelding van de prijslaag (`url`, `blurhash`) die op de productpagina wordt getoond; `null` wanneer er geen afbeelding is ingesteld.

**initial\_price** `number` *required*

Initiële aankoopprijs, in `currency`.

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

Totaal dat bij de checkout voor één eenheid in rekening wordt gebracht, vóór promotiecodes en belasting: `initial_price` plus de eerste `renewal_price` voor terugkerende varianten, of alleen `initial_price` zolang er een gratis proefperiode geldt. De proefperiode geldt niet wanneer de bekijkende gebruiker er al een voor deze variant heeft gebruikt. Uitgedrukt in `currency`.

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

**internal\_notes** `string | null` *required*

Privénotities die niet aan klanten worden getoond. `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

**invoice** `object | null` *required*

Factuur waarvoor deze variant is gegenereerd; `null` tenzij aangemaakt voor een factuur.

**member\_count** `number | null` *required*

Actieve memberships via deze variant. `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

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

Aangepaste sleutel-waardeparen die op de variant zijn opgeslagen. Opgenomen in webhook-payloads voor betalings- en membership-events. Maximaal 50 sleutels, 100 tekens per sleutel, 500 tekens per waarde. De gereserveerde sleutels `custom_cta` en `custom_cta_url` overschrijven, wanneer ingesteld, de checkout-call-to-action van het product voor deze variant.

**offer\_cancel\_discount** `boolean | null` *required*

Of er een annuleringskorting wordt aangeboden. `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

**payment\_method\_configuration** `object | null` *required*

Configuratie van betaalmethoden (`enabled`, `disabled`, `include_platform_defaults`); `null` wanneer de variant standaardinstellingen gebruikt.

**product** `object | null` *required*

Product waartoe deze variant behoort; `null` voor zelfstandige varianten.

**purchase\_url** `string` *required*

URL waar klanten deze variant direct kunnen kopen.

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

Waar de klant naartoe wordt gestuurd na betaling voor deze variant. `null` wanneer er niets is ingesteld, of tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

**release\_method** `string` *required*

Verkoopmethode voor deze variant.

Beschikbare opties: `buy_now`, `waitlist`

**renewal\_price** `number` *required*

Terugkerende prijs die elke factureringsperiode in rekening wordt gebracht, in `currency`.

**sku** `string | null` *required*

Stock keeping unit, vrije tekst ingesteld door de verkoper (bijv. `TSHIRT-LARGE-BLUE`). Uniciteit wordt niet afgedwongen. `null` wanneer niet ingesteld.

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

Termijnbetalingen die vereist zijn voordat het abonnement wordt gepauzeerd. Moet groter zijn dan 1. `null` als gespreid betalen niet is geconfigureerd.

**stock** `number | null` *required*

Eenheden beschikbaar voor aankoop. `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

**strike\_through\_initial\_price** `number | null` *required*

Oorspronkelijke initiële prijs, doorgestreept weergegeven, in `currency`. `null` wanneer er geen doorgestreepte prijs is ingesteld.

**strike\_through\_renewal\_price** `number | null` *required*

Oorspronkelijke verlengingsprijs, doorgestreept weergegeven, in `currency`. `null` wanneer er geen doorgestreepte prijs is ingesteld.

**tax\_type** `string` *required*

Hoe belasting voor deze variant wordt afgehandeld, inclusief of belasting in de prijs is inbegrepen, bij de checkout wordt toegevoegd of niet is geconfigureerd.

Beschikbare opties: `inclusive`, `exclusive`, `unspecified`

**three\_ds\_level** `string | null` *required*

3D Secure-gedrag voor ondersteunde on-session kaartbetalingen. `mandate_challenge` vereist een 3DS-challenge voordat de betaling wordt verwerkt; `mandate_if_required` vereist alleen een challenge wanneer de betalingsverwerker dat vereist; `frictionless_if_required` gebruikt de gewone frictionless 3DS-flow. Betalingen van \$1.000 of meer gebruiken `mandate_if_required`, tenzij `mandate_challenge` is geselecteerd. Vereisten voor risico- en authenticatieherstel kunnen de voorkeur overschrijven. `null` neemt de standaard van het account over.

Beschikbare opties: `mandate_challenge`, `mandate_if_required`, `frictionless_if_required`

**title** `string | null` *required*

Weergavenaam van de variant die aan klanten wordt getoond. Maximaal 30 tekens. Een variant die zonder naam is aangemaakt, krijgt standaard de attribuutwaarden samengevoegd met `/`. `null` als er geen titel is ingesteld.

**trial\_period\_days** `number | null` *required*

Dagen gratis proefperiode vóór de eerste verlengingsafschrijving. `null` als er geen proefperiode is geconfigureerd of de gebruiker al een proefperiode voor deze variant heeft gebruikt.

**unlimited\_stock** `boolean` *required*

Of de variant onbeperkte voorraad heeft. Wanneer `true`, wordt het veld `stock` genegeerd; wachtlijstvarianten rapporteren altijd `true`.

**unpaid\_invoice\_count** `integer | null` *required*

Aantal uitgegeven facturen voor deze variant die niet zijn betaald of ongeldig gemaakt. Zolang dit boven `0` ligt, kun je de prijzen, factureringsperiode, proefperiode, het aantal betalingen, de valuta of het factureringstype van de variant niet wijzigen. `null` tenzij de actor de scope `plan:basic:read` heeft op het account van de variant.

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

Wanneer de variant voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.

**visibility** `string` *required*

Bepaalt waar deze variant zichtbaar is. Wanneer `hidden`, is de variant alleen bereikbaar via de directe link.

Beschikbare opties: `visible`, `hidden`, `archived`, `quick_link`

```json Variant theme={null}
{
	"id": "plan_xxxxxxxxxxxxx",
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe"
	},
	"adaptive_pricing_enabled": true,
	"allow_multiple_quantity": false,
	"attributes": {
		"seats": "5",
		"tier": "Pro"
	},
	"billing_period": 30,
	"cancel_discount_intervals": null,
	"cancel_discount_percentage": null,
	"checkout_styling": null,
	"collect_tax": true,
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"custom_fields": [
		{
			"id": "cusf_xxxxxxxxxxxx",
			"field_type": "text",
			"name": "Discord username",
			"order": 0,
			"placeholder": "e.g. pickaxe_user",
			"required": true
		}
	],
	"deletable": false,
	"description": "Monthly access to Pickaxe Analytics.",
	"expiration_days": null,
	"formatted_price": "$29.00 / month",
	"image": null,
	"initial_price": 29,
	"internal_notes": "Standard monthly variant",
	"redirect_url": null,
	"invoice": null,
	"member_count": 42,
	"metadata": {
		"external_plan_id": "monthly",
		"custom_cta": "subscribe",
		"custom_cta_url": "https://example.com/wash-club"
	},
	"offer_cancel_discount": false,
	"payment_method_configuration": {
		"enabled": ["card"],
		"disabled": [],
		"include_platform_defaults": true
	},
	"effective_payment_method_configuration": {
		"enabled": ["card"],
		"disabled": [],
		"include_platform_defaults": true
	},
	"billing_type": "renewal",
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Analytics"
	},
	"purchase_url": "https://whop.com/pickaxe-analytics/checkout/plan_xxxxxxxxxxxxx",
	"release_method": "buy_now",
	"renewal_price": 29,
	"initial_price_due": {
		"currency": "usd",
		"amount": "29.00",
		"decimals": 2,
		"display_decimals": 2
	},
	"sku": "PICKAXE-PRO-5-MONTHLY",
	"split_pay_required_payments": null,
	"stock": null,
	"strike_through_initial_price": null,
	"strike_through_renewal_price": null,
	"tax_type": "exclusive",
	"three_ds_level": "frictionless_if_required",
	"title": "Pro / 5 seats",
	"trial_period_days": 7,
	"unlimited_stock": true,
	"unpaid_invoice_count": 0,
	"updated_at": "2023-12-01T05:00:00.401Z",
	"visibility": "visible"
}
```


## Related topics

- [Variants](https://docs.whop.com/nl/api-reference/legacy/variants/variant.md)
- [API-versies](https://docs.whop.com/nl/developer/api/versioning.md)
- [Delete Variant](https://docs.whop.com/nl/api-reference/variants/delete-variant.md)
