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

# CheckoutSession

> Low-level, headless checkoutsessie voor een pagina die zijn eigen PayPal-knop tekent. `load()` maakt de checkoutsessie aan op basis van `lineItems`; `show("paypal", { termsAccepted: true })` stuurt de koper naar PayPal — een pop-upvenster op desktop, het hele tabblad op telefoons — en wordt opgelost met de betaling zodra de koper akkoord geeft. Met `paymentMethodOptions.paypal.requestShipping` vraagt PayPal de koper om een verzendadres en prijst de webhook van het account die is geabonneerd op `shipping_address.changed` elk adres op je server terwijl de koper op PayPal is; de betaling wordt pas aangemaakt nadat de koper akkoord geeft, tegen die prijs. Na een volledige paginaredirect wordt de promise nooit afgehandeld; lees de uitkomst in plaats daarvan uit de queryparameters `payment` en `status` van `redirectUrl`.

> [!NOTE]
>
> Deze pagina documenteert `@whop/elements@1.10.0` en `@whop/elements-react@1.10.0`.

*Sinds `v1.10.0`.*

Maak deze [`Checkout`](https://docs.whop.com/nl/elements/latest/checkout/overview)-resource aan zonder een element te mounten: `whop.checkout.checkoutSession.create({ … })` in vanilla of `useWhop().checkout.checkoutSession.create({ … })` in React.

## Opties

Geef deze mee aan `whop.checkout.checkoutSession.create({ … })`.

**accountId** `string` *required*

Account-ID, met prefix `biz_`, dat de regelitems verkoopt.

**lineItems** `CheckoutSessionLineItem[]` *required*

Wat de koper koopt: elke vermelding noemt een variant (`plan_…`) en een optionele `quantity` (standaard 1). Meerdere vermeldingen vormen een winkelwagen.

**eigenschappen**

**variant** `string` *required*

**quantity** `number`

**redirectUrl** `string` *required*

Waar de koper na PayPal terechtkomt wanneer het tabblad werd doorgestuurd, met `payment` en `status` toegevoegd: `succeeded`, `canceled`, `failed` of `processing` zolang Whop de afschrijving nog afrondt (lees de betaling vanaf je server om te zien wanneer die is verwerkt). Op desktop sluit in plaats daarvan de pop-up en wordt `show()` afgehandeld.

**metadata** `Record\<string, string\>`

Je eigen stringsleutels en -waarden, maximaal 40, bewaard op de checkoutsessie en gekopieerd naar de betaling die deze aanmaakt, zodat ze terugkomen op de betaling en de bijbehorende webhooks, bijvoorbeeld voor advertentie- en affiliate-attributie. Ze worden ingesteld vanuit de browser van de koper, dus vertrouw er nooit op voor prijzen of levering.

**setupFutureUsage** `"off_session"`

Stel in op `off_session` om het PayPal-account van de koper op te slaan, zodat je server het later zonder de koper kan belasten, bijvoorbeeld voor een upsell met één klik. PayPal vraagt de koper tijdens het akkoord om in te stemmen met toekomstige betalingen. Stel dit pas in nadat je de koper hebt verteld dat het PayPal-account wordt opgeslagen.

**email** `string`

Het e-mailadres van de koper, waartoe de betaling en het lidmaatschap behoren. Laat het weg om het e-mailadres te gebruiken van het PayPal-account dat akkoord geeft.

**paymentMethodOptions** `CheckoutSessionPaymentMethodOptions`

Opties voor één betaalmethode. Met `paypal.requestShipping` vraagt PayPal de koper om een verzendadres. Wanneer het account een ingeschakelde `https`-webhook heeft die is geabonneerd op `shipping_address.changed`, roept Whop die aan voor elk adres en rekent de totalen af waarmee die antwoordt. Standaard `false`.

**eigenschappen**

**paypal** `CheckoutSessionPayPalOptions`

**eigenschappen**

**requestShipping** `boolean`

## Methoden

Roep deze aan op de resource.

> [!WARNING]
>
> Roep `show` synchroon aan tijdens gebruikersactivatie. Wacht eerst op vereisten.

### `load`

Maak de checkoutsessie aan op basis van `lineItems`. Opnieuw aanroepen geeft dezelfde sessie terug. `show()` laadt deze eerst wanneer die nog niet is geladen. `terms` is wat de koper accepteert door te betalen: toon de `links` ervan (het gepubliceerde beleid van de verkoper en de kopersvoorwaarden van Whop) naast je knop, en laat de koper ze actief accepteren wanneer `terms.required` `true` is, bijvoorbeeld met een selectievakje. `requirements` geeft aan wat de sessie nodig heeft voordat die kan worden betaald: alles behalve `email`, `terms` en, met `paypal.requestShipping`, `shipping_address` kan hier niet worden verzameld, dus `show()` weigert het.

**Retourneert** `Promise<CheckoutSessionLoaded>`

**id** `string` *required*

**status** `string` *required*

**requirements** `string[]` *required*

**terms** `CheckoutSessionTerms` *required*

**eigenschappen**

**required** `boolean` *required*

**links** `CheckoutSessionTermsLink[]` *required*

**eigenschappen**

**kind** `string` *required*

Een van `"terms_of_service"`, `"privacy_policy"`, `"return_policy"`, `"eula"`, `"whop_buyer_terms"` of `"whop_privacy_policy"`.

**url** `string` *required*

### `show`

Roep het synchroon aan in de klikhandler van je PayPal-knop: op desktop opent het daar de pop-up, en een later geopende pop-up wordt geblokkeerd. Geef `termsAccepted: true` alleen mee wanneer de `terms.links` van `load()` voor deze klik naast de knop werden getoond en, wanneer `terms.required` `true` is, de koper ze actief heeft geaccepteerd. Wordt opgelost met `{ payment }` zodra de koper akkoord geeft en Whop afschrijft. Wordt afgewezen met een fout waarvan de `code` `attestation_required` is zonder `termsAccepted`, `requirements_unsupported` wanneer de sessie iets nodig heeft dat PayPal niet kan verzamelen (zie `requirements` van `load()`), `payment_request_cancelled` wanneer de koper PayPal annuleert of sluit, `seller_pricing_unavailable` wanneer het account deze betaling niet via zijn webhook kan prijzen (het verwerkt zijn eigen belasting niet, of de winkelwagen bevat een promotiecode, kopersvergoeding, marketplace-verdeling of een abonnement dat wordt verlengd), of anders `payment_failed`. Op telefoons gaat het tabblad naar PayPal en wordt de promise nooit afgehandeld. Roep het synchroon aan tijdens gebruikersactivatie. Wacht eerst op vereisten, omdat browsers de activatie intrekken over asynchrone stappen heen.

**Parameters**

**paymentMethod** `"paypal"` *required*

**options** `CheckoutSessionShowOptions`

**eigenschappen**

**termsAccepted** `boolean`

**Retourneert** `Promise<CheckoutSessionConfirmResult>`

**payment** `CheckoutSessionPayment` *required*

**eigenschappen**

**id** `string` *required*

**status** `string` *required*


## Related topics

- [Checkout](https://docs.whop.com/nl/elements/latest/checkout/overview.md)
- [Migreren vanaf eerdere versies](https://docs.whop.com/nl/developer/api/migrate-from-previous-versions.md)
- [Migreren van legacy-facturen](https://docs.whop.com/nl/developer/guides/migrate-from-legacy-invoices.md)
