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

> Sesión de checkout headless de bajo nivel para una página que dibuja su propio botón de PayPal. `load()` crea la sesión de checkout a partir de `lineItems`; `show("paypal", { termsAccepted: true })` envía al comprador a PayPal (una ventana emergente en escritorio, la pestaña completa en teléfonos) y se resuelve con el pago una vez que el comprador lo aprueba. Con `paymentMethodOptions.paypal.requestShipping`, PayPal le pide al comprador una dirección de envío y el webhook de la cuenta suscrito a `shipping_address.changed` calcula el precio de cada una en tu servidor mientras el comprador está en PayPal; el pago se crea solo después de que el comprador lo aprueba, a ese precio. Tras una redirección de página completa, la promesa nunca se resuelve; en su lugar, lee el resultado de los parámetros de consulta `payment` y `status` de `redirectUrl`.

> [!NOTE]
>
> Esta página documenta `@whop/elements@1.10.0` y `@whop/elements-react@1.10.0`.

*Desde `v1.10.0`.*

Crea este recurso de [`Checkout`](https://docs.whop.com/es/elements/latest/checkout/overview) sin montar un elemento: `whop.checkout.checkoutSession.create({ … })` en vanilla o `useWhop().checkout.checkoutSession.create({ … })` en React.

## Opciones

Pásalas a `whop.checkout.checkoutSession.create({ … })`.

**accountId** `string` *required*

ID de la cuenta, con prefijo `biz_`, que vende los artículos.

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

Lo que compra el comprador: cada entrada nombra una variante (`plan_…`) y una `quantity` opcional (por defecto 1). Varias entradas forman un carrito.

**propiedades**

**variant** `string` *required*

**quantity** `number`

**redirectUrl** `string` *required*

Adónde llega el comprador después de PayPal cuando la pestaña fue redirigida, con `payment` y `status` añadidos: `succeeded`, `canceled`, `failed` o `processing` mientras Whop todavía está terminando el cobro (consulta el pago desde tu servidor para ver cuándo se completa). En escritorio, en cambio, la ventana emergente se cierra y `show()` se resuelve.

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

Tus propias claves y valores de tipo string, hasta 40, que se guardan en la sesión de checkout y se copian en el pago que crea, de modo que vuelven en el pago y en sus webhooks, por ejemplo para la atribución de anuncios y afiliados. Se establecen desde el navegador del comprador, así que nunca dependas de ellos para precios ni para el cumplimiento de pedidos.

**setupFutureUsage** `"off_session"`

Establécelo en `off_session` para guardar la cuenta de PayPal del comprador, de modo que tu servidor pueda cobrarle más tarde sin el comprador, por ejemplo para una venta adicional con un clic. PayPal le pide al comprador que acepte pagos futuros mientras aprueba. Establécelo solo después de informar al comprador de que se guardará su cuenta de PayPal.

**email** `string`

El correo electrónico del comprador, al que pertenecen el pago y la membresía. Omítelo para usar el correo electrónico de la cuenta de PayPal que aprueba.

**paymentMethodOptions** `CheckoutSessionPaymentMethodOptions`

Opciones para un método de pago. `paypal.requestShipping` hace que PayPal le pida al comprador una dirección de envío. Cuando la cuenta tiene un webhook `https` habilitado suscrito a `shipping_address.changed`, Whop lo llama para cada dirección y cobra los totales con los que responde. Por defecto es `false`.

**propiedades**

**paypal** `CheckoutSessionPayPalOptions`

**propiedades**

**requestShipping** `boolean`

## Métodos

Llámalos en el recurso.

> [!WARNING]
>
> Llama a `show` de forma síncrona durante la activación del usuario. Espera primero los requisitos previos.

### `load`

Crea la sesión de checkout a partir de `lineItems`. Llamarlo de nuevo devuelve la misma sesión. `show()` la carga primero si no se ha cargado. `terms` es lo que el comprador acepta al pagar: muestra sus `links` (las políticas publicadas del vendedor y los términos para compradores de Whop) junto a tu botón y, cuando `terms.required` es `true`, haz que el comprador los acepte de forma activa, por ejemplo con una casilla de verificación. `requirements` enumera lo que la sesión necesita antes de poder pagarse: cualquier cosa que no sea `email`, `terms` y, con `paypal.requestShipping`, `shipping_address` no puede recopilarse aquí, por lo que `show()` la rechaza.

**Devuelve** `Promise<CheckoutSessionLoaded>`

**id** `string` *required*

**status** `string` *required*

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

**terms** `CheckoutSessionTerms` *required*

**propiedades**

**required** `boolean` *required*

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

**propiedades**

**kind** `string` *required*

Uno de `"terms_of_service"`, `"privacy_policy"`, `"return_policy"`, `"eula"`, `"whop_buyer_terms"` o `"whop_privacy_policy"`.

**url** `string` *required*

### `show`

Llámalo de forma síncrona en el controlador de clic de tu botón de PayPal: en escritorio abre ahí la ventana emergente, y una ventana emergente abierta más tarde se bloquea. Pasa `termsAccepted: true` solo cuando los `terms.links` de `load()` se mostraron junto al botón para esta pulsación y, cuando `terms.required` es `true`, el comprador los aceptó de forma activa. Se resuelve con `{ payment }` una vez que el comprador aprueba y Whop cobra. Se rechaza con un error cuyo `code` es `attestation_required` sin `termsAccepted`, `requirements_unsupported` cuando la sesión necesita algo que PayPal no puede recopilar (consulta los `requirements` de `load()`), `payment_request_cancelled` cuando el comprador cancela o cierra PayPal, `seller_pricing_unavailable` cuando la cuenta no puede calcular el precio de este pago a través de su webhook (no gestiona sus propios impuestos, o el carrito tiene un código promocional, una comisión para el comprador, un reparto de marketplace o un plan que se renueva), o `payment_failed` en los demás casos. En teléfonos, la pestaña va a PayPal y la promesa nunca se resuelve. Llámalo de forma síncrona durante la activación del usuario. Espera primero los requisitos previos, porque los navegadores revocan la activación entre pasos asíncronos.

**Parámetros**

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

**options** `CheckoutSessionShowOptions`

**propiedades**

**termsAccepted** `boolean`

**Devuelve** `Promise<CheckoutSessionConfirmResult>`

**payment** `CheckoutSessionPayment` *required*

**propiedades**

**id** `string` *required*

**status** `string` *required*
