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

> Session de checkout headless de bas niveau pour une page qui affiche son propre bouton PayPal. `load()` crée la session de checkout à partir de `lineItems` ; `show("paypal", { termsAccepted: true })` envoie l'acheteur vers PayPal — une fenêtre pop-up sur ordinateur, l'onglet entier sur téléphone — et se résout avec le paiement une fois que l'acheteur a approuvé. Avec `paymentMethodOptions.paypal.requestShipping`, PayPal demande une adresse de livraison à l'acheteur et le webhook du compte abonné à `shipping_address.changed` calcule le prix de chacune sur votre serveur pendant que l'acheteur est sur PayPal ; le paiement n'est créé qu'après l'approbation de l'acheteur, à ce prix. Après une redirection pleine page, la promesse ne se résout jamais ; lisez plutôt le résultat dans les paramètres de requête `payment` et `status` de `redirectUrl`.

> [!NOTE]
>
> Cette page documente `@whop/elements@1.10.0` et `@whop/elements-react@1.10.0`.

*Depuis `v1.10.0`.*

Créez cette ressource [`Checkout`](https://docs.whop.com/fr/elements/latest/checkout/overview) sans monter d'élément : `whop.checkout.checkoutSession.create({ … })` en vanilla ou `useWhop().checkout.checkoutSession.create({ … })` avec React.

## Options

Transmettez-les à `whop.checkout.checkoutSession.create({ … })`.

**accountId** `string` *required*

ID du compte, préfixé par `biz_`, qui vend les articles.

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

Ce que l'acheteur achète : chaque entrée désigne une variante (`plan_…`) et une `quantity` facultative (1 par défaut). Plusieurs entrées forment un panier.

**propriétés**

**variant** `string` *required*

**quantity** `number`

**redirectUrl** `string` *required*

L'endroit où l'acheteur arrive après PayPal lorsque l'onglet a été redirigé, avec `payment` et `status` ajoutés : `succeeded`, `canceled`, `failed`, ou `processing` tant que Whop finalise encore le débit (lisez le paiement depuis votre serveur pour voir son règlement). Sur ordinateur, la pop-up se ferme à la place et `show()` se résout.

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

Vos propres clés et valeurs de type chaîne, jusqu'à 40, conservées sur la session de checkout et copiées sur le paiement qu'elle crée, de sorte qu'elles reviennent sur le paiement et ses webhooks, par exemple pour l'attribution publicitaire et d'affiliation. Elles sont définies depuis le navigateur de l'acheteur, donc ne vous y fiez jamais pour les prix ou l'exécution des commandes.

**setupFutureUsage** `"off_session"`

Définissez sur `off_session` pour enregistrer le compte PayPal de l'acheteur afin que votre serveur puisse le débiter plus tard sans l'acheteur, par exemple pour un upsell en un clic. PayPal demande à l'acheteur d'accepter les paiements futurs au moment de l'approbation. Ne le définissez qu'après avoir informé l'acheteur que son compte PayPal sera enregistré.

**email** `string`

L'e-mail de l'acheteur, auquel appartiennent le paiement et l'adhésion. Omettez-le pour utiliser l'e-mail du compte PayPal qui approuve.

**paymentMethodOptions** `CheckoutSessionPaymentMethodOptions`

Options pour un moyen de paiement. `paypal.requestShipping` fait demander une adresse de livraison à l'acheteur par PayPal. Lorsque le compte dispose d'un webhook `https` activé abonné à `shipping_address.changed`, Whop l'appelle pour chaque adresse et débite les totaux qu'il renvoie. Par défaut : `false`.

**propriétés**

**paypal** `CheckoutSessionPayPalOptions`

**propriétés**

**requestShipping** `boolean`

## Méthodes

Appelez-les sur la ressource.

> [!WARNING]
>
> Appelez `show` de manière synchrone pendant l'activation utilisateur. Attendez d'abord les prérequis.

### `load`

Crée la session de checkout à partir de `lineItems`. Un nouvel appel renvoie la même session. `show()` la charge d'abord si elle n'a pas été chargée. `terms` correspond à ce que l'acheteur accepte en payant : affichez ses `links` (les politiques publiées du vendeur et les conditions acheteur de Whop) à côté de votre bouton, et lorsque `terms.required` vaut `true`, faites-les accepter activement par l'acheteur, par exemple avec une case à cocher. `requirements` liste ce dont la session a besoin avant de pouvoir être payée : tout ce qui n'est pas `email`, `terms` et, avec `paypal.requestShipping`, `shipping_address` ne peut pas être collecté ici, donc `show()` le refuse.

**Renvoie** `Promise<CheckoutSessionLoaded>`

**id** `string` *required*

**status** `string` *required*

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

**terms** `CheckoutSessionTerms` *required*

**propriétés**

**required** `boolean` *required*

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

**propriétés**

**kind** `string` *required*

L'une des valeurs `"terms_of_service"`, `"privacy_policy"`, `"return_policy"`, `"eula"`, `"whop_buyer_terms"` ou `"whop_privacy_policy"`.

**url** `string` *required*

### `show`

Appelez-la de manière synchrone dans le gestionnaire de clic de votre bouton PayPal : sur ordinateur, elle ouvre la pop-up à ce moment-là, et une pop-up ouverte plus tard est bloquée. Transmettez `termsAccepted: true` uniquement lorsque les `terms.links` de `load()` ont été affichés à côté du bouton pour ce clic et, lorsque `terms.required` vaut `true`, que l'acheteur les a activement acceptés. Se résout avec `{ payment }` une fois que l'acheteur a approuvé et que Whop a débité. Rejette avec une erreur dont le `code` est `attestation_required` sans `termsAccepted`, `requirements_unsupported` lorsque la session a besoin de quelque chose que PayPal ne peut pas collecter (voir les `requirements` de `load()`), `payment_request_cancelled` lorsque l'acheteur annule ou ferme PayPal, `seller_pricing_unavailable` lorsque le compte ne peut pas calculer le prix de ce paiement via son webhook (il ne gère pas ses propres taxes, ou le panier contient un code promo, des frais acheteur, une répartition marketplace ou un plan qui se renouvelle), ou `payment_failed` dans les autres cas. Sur téléphone, l'onglet part vers PayPal et la promesse ne se résout jamais. Appelez-la de manière synchrone pendant l'activation utilisateur. Attendez d'abord les prérequis, car les navigateurs révoquent l'activation au fil des étapes asynchrones.

**Paramètres**

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

**options** `CheckoutSessionShowOptions`

**propriétés**

**termsAccepted** `boolean`

**Renvoie** `Promise<CheckoutSessionConfirmResult>`

**payment** `CheckoutSessionPayment` *required*

**propriétés**

**id** `string` *required*

**status** `string` *required*
