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

# Configuration de checkout

> Une configuration de checkout est une configuration réutilisable pour un checkout, comprenant le plan, l'affilié et des métadonnées personnalisées. Les paiements et abonnements créés à partir d'une session de checkout héritent de ses métadonnées.

> [!NOTE]
>
> Cette ressource a un successeur dans l'[API Whop](https://docs.whop.com/fr/api-reference/legacy/checkout-configurations/checkout-configuration.md), l'API versionnée sur laquelle les nouvelles intégrations doivent s'appuyer. Cette page reste entièrement prise en charge.

```json Example theme={null}
{
	"account_id": "<string>",
	"affiliate_code": "<string>",
	"company_id": "<string>",
	"currency": "usd",
	"id": "ch_xxxxxxxxxxxxxxx",
	"metadata": {},
	"mode": "payment",
	"payment_method_configuration": {
		"disabled": ["acss_debit"],
		"enabled": ["acss_debit"],
		"include_platform_defaults": true
	},
	"plan": {
		"adaptive_pricing_enabled": true,
		"billing_period": 42,
		"currency": "usd",
		"expiration_days": 42,
		"id": "plan_xxxxxxxxxxxxx",
		"initial_price": 6.9,
		"plan_type": "renewal",
		"release_method": "buy_now",
		"renewal_price": 6.9,
		"three_ds_level": "mandate_challenge",
		"trial_period_days": 42,
		"visibility": "visible"
	},
	"purchase_url": "<string>",
	"redirect_url": "<string>"
}
```

**account\_id** `string` *required*

L'ID du compte à utiliser pour la configuration de checkout

**affiliate\_code** `string | null` *required*

Le code d'affilié à utiliser pour la configuration de checkout

**company\_id** `string` *required*

L'ID du compte à utiliser pour la configuration de checkout

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

La devise à utiliser pour la configuration en mode 'setup'. Elle sert à déterminer quels moyens de paiement propres à une devise sont disponibles. Si elle n'est pas fournie, elle vaut 'usd' par défaut en mode setup.

Options disponibles : `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`

**id** `string` *required*

L'identifiant unique de la session de checkout.

Exemple : `ch_xxxxxxxxxxxxxxx`

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

Les métadonnées à utiliser pour la configuration de checkout

**mode** `CheckoutModes` *required*

Le mode de la session de checkout.

Options disponibles : `payment`, `setup`

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

La configuration explicite des moyens de paiement pour la session, le cas échéant. Cela ne fonctionne actuellement qu'en mode 'setup'. Utilisez le payment\_method\_configuration du plan pour le moyen de paiement.

**attributs enfants**

**disabled** `array\<PaymentMethodTypes\>` *required*

Un tableau d'identifiants de moyens de paiement explicitement désactivés. Ne s'applique que si include\_platform\_defaults vaut true.

Options disponibles : `acss_debit`, `addi`, `affirm`, `afterpay_clearpay`, `alipay`, `alipayhk`, `alma`, `amazon_pay`, `apple`, `apple_pay`, `au_bank_transfer`, `au_becs_debit`, `bacs_debit`, `bancolombia`, `bancontact`, `bank_wire`, `billie`, `blik`, `boleto`, `bre_b`, `ca_bank_transfer`, `capchase_pay`, `card`, `card_present`, `card_installments_three`, `card_installments_six`, `card_installments_twelve`, `cashapp`, `claritypay`, `coinbase`, `crypto`, `crypto_subscription`, `custom`, `customer_balance`, `demo_pay`, `duitnow_qr`, `efecty`, `eps`, `eu_bank_transfer`, `fpx`, `flex_pay`, `gb_bank_transfer`, `gcash`, `giropay`, `google_pay`, `gopay`, `grabpay`, `id_bank_transfer`, `ideal`, `interac`, `international_bank_wire`, `kakao_pay`, `klarna`, `klarna_pay_now`, `konbini`, `kr_card`, `kr_market`, `kriya`, `kueski`, `link`, `mb_way`, `m_pesa`, `mercado_pago`, `mercado_pago_ar`, `mercado_pago_mx`, `mobilepay`, `modo`, `mondu`, `multibanco`, `naver_pay`, `nequi`, `netbanking`, `ng_bank`, `ng_bank_transfer`, `ng_card`, `ng_market`, `ng_ussd`, `ng_wallet`, `nupay`, `nz_bank_account`, `oney`, `oney_3x`, `oney_4x`, `opay`, `oxxo`, `p24`, `pago_efectivo`, `pse`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `paypal_express`, `paypay`, `payto`, `payto_email`, `payto_phone`, `payto_bank_account`, `pix`, `pix_automatico`, `platform_balance`, `promptpay`, `qris`, `rapipago`, `rechnung`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sencillito`, `sepa_debit`, `sequra`, `servipag`, `sezzle`, `shop_pay`, `shopeepay`, `sofort`, `south_korea_market`, `spei`, `splitit`, `sunbit`, `swish`, `tabby`, `tamara`, `touch_n_go`, `twint`, `upi`, `us_bank_account`, `us_bank_transfer`, `venmo`, `verve`, `vipps`, `webpay`, `wechat_pay`, `whop_pay`, `yape`, `zip`, `coinflow`, `unknown`

**enabled** `array\<PaymentMethodTypes\>` *required*

Un tableau d'identifiants de moyens de paiement explicitement activés. Ces moyens de paiement seront donc affichés au checkout. Exemple d'utilisation : n'activer qu'un moyen de paiement spécifique comme cashapp, ou compléter les valeurs par défaut de la plateforme avec des moyens supplémentaires.

Options disponibles : `acss_debit`, `addi`, `affirm`, `afterpay_clearpay`, `alipay`, `alipayhk`, `alma`, `amazon_pay`, `apple`, `apple_pay`, `au_bank_transfer`, `au_becs_debit`, `bacs_debit`, `bancolombia`, `bancontact`, `bank_wire`, `billie`, `blik`, `boleto`, `bre_b`, `ca_bank_transfer`, `capchase_pay`, `card`, `card_present`, `card_installments_three`, `card_installments_six`, `card_installments_twelve`, `cashapp`, `claritypay`, `coinbase`, `crypto`, `crypto_subscription`, `custom`, `customer_balance`, `demo_pay`, `duitnow_qr`, `efecty`, `eps`, `eu_bank_transfer`, `fpx`, `flex_pay`, `gb_bank_transfer`, `gcash`, `giropay`, `google_pay`, `gopay`, `grabpay`, `id_bank_transfer`, `ideal`, `interac`, `international_bank_wire`, `kakao_pay`, `klarna`, `klarna_pay_now`, `konbini`, `kr_card`, `kr_market`, `kriya`, `kueski`, `link`, `mb_way`, `m_pesa`, `mercado_pago`, `mercado_pago_ar`, `mercado_pago_mx`, `mobilepay`, `modo`, `mondu`, `multibanco`, `naver_pay`, `nequi`, `netbanking`, `ng_bank`, `ng_bank_transfer`, `ng_card`, `ng_market`, `ng_ussd`, `ng_wallet`, `nupay`, `nz_bank_account`, `oney`, `oney_3x`, `oney_4x`, `opay`, `oxxo`, `p24`, `pago_efectivo`, `pse`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `paypal_express`, `paypay`, `payto`, `payto_email`, `payto_phone`, `payto_bank_account`, `pix`, `pix_automatico`, `platform_balance`, `promptpay`, `qris`, `rapipago`, `rechnung`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sencillito`, `sepa_debit`, `sequra`, `servipag`, `sezzle`, `shop_pay`, `shopeepay`, `sofort`, `south_korea_market`, `spei`, `splitit`, `sunbit`, `swish`, `tabby`, `tamara`, `touch_n_go`, `twint`, `upi`, `us_bank_account`, `us_bank_transfer`, `venmo`, `verve`, `vipps`, `webpay`, `wechat_pay`, `whop_pay`, `yape`, `zip`, `coinflow`, `unknown`

**include\_platform\_defaults** `boolean` *required*

Indique si les paramètres d'activation des moyens de paiement par défaut de la plateforme Whop sont inclus dans cette configuration. La liste complète des moyens de paiement par défaut est disponible dans la documentation sur docs.whop.com/payments.

**plan** `object | null` *required*

Le plan à utiliser pour la configuration de checkout

**attributs enfants**

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

Indique si le créateur a activé la tarification adaptative pour ce plan. Paramètre brut — ne vérifie ni la compatibilité du processeur ni les feature flags.

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

Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un plan mensuel ou 365 pour un plan annuel. `null` pour les plans à paiement unique.

Exemple : `42`

**currency** `Currencies` *required*

La devise utilisée pour tous les prix de ce plan (par ex. 'usd', 'eur'). Tous les montants du plan sont libellés dans cette devise.

Options disponibles : `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`

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

Durée d'accès en jours pour les plans avec expiration, par exemple 365 pour un pass d'un an.

Exemple : `42`

**id** `string` *required*

L'identifiant unique du plan.

Exemple : `plan_xxxxxxxxxxxxx`

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

Le prix d'achat initial dans la base\_currency du plan (par ex. 49.99 pour 49,99 \$). Pour les plans à paiement unique, il s'agit du prix total. Pour les plans à renouvellement, ce montant est prélevé en plus du premier renewal\_price.

Exemple : `6.9`

**plan\_type** `PlanTypes` *required*

Le modèle de facturation de ce plan : 'renewal' pour les abonnements récurrents ou 'one\_time' pour les paiements uniques.

Options disponibles : `renewal`, `one_time`

**release\_method** `ReleaseMethod` *required*

Mode de vente de ce plan : `buy_now` pour un achat immédiat ou `waitlist` pour un accès via liste d'attente.

Options disponibles : `buy_now`, `waitlist`

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

Le prix récurrent prélevé à chaque billing\_period dans la base\_currency du plan (par ex. 9.99 pour 9,99 \$/période). Zéro pour les plans à paiement unique.

Exemple : `6.9`

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

Le comportement 3D Secure de ce plan. Null signifie que le plan hérite de la valeur par défaut du compte.

Options disponibles : `mandate_challenge`, `frictionless`

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

Jours d'essai gratuit avant le premier prélèvement de renouvellement. `null` si aucun essai n'est configuré ou si l'utilisateur a déjà utilisé un essai pour ce plan.

Exemple : `42`

**visibility** `Visibility` *required*

Détermine si le plan est visible par les clients. Lorsqu'il vaut 'hidden', le plan n'est accessible que via un lien direct.

Options disponibles : `visible`, `hidden`, `archived`, `quick_link`

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

Une URL que vous pouvez envoyer aux clients pour finaliser un checkout. Elle ressemble à `/checkout/ch_xxxx/`

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

L'URL vers laquelle rediriger l'utilisateur après la création de la configuration de checkout


## Related topics

- [Checkout](https://docs.whop.com/fr/elements/latest/checkout/overview.md)
- [Versions de l'API](https://docs.whop.com/fr/developer/api/versioning.md)
- [Enregistrer des moyens de paiement](https://docs.whop.com/fr/developer/guides/save-payment-methods.md)
