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

# API Checkout Configurations

> Une Checkout Configuration est un lien de paiement réutilisable appartenant à un compte.

En mode `payment`, elle vend une variante spécifique ; en mode `setup`, elle collecte et enregistre les informations de paiement sans débiter. Chaque configuration peut également remplacer les moyens de paiement acceptés et la manière dont 3D Secure est appliqué pour ce paiement.

Utilisez l'API Checkout Configurations pour créer des liens de paiement pour une variante existante ou définie en ligne, lister les configurations d'un compte, récupérer la configuration associée à une URL de paiement et supprimer les liens qui ne doivent plus être utilisés.

> [!NOTE]
>
> Remplace la ressource Legacy [Checkout
> configurations](https://docs.whop.com/fr/api-reference/checkout-configurations/checkout-configuration).
> Les intégrations Legacy existantes continuent de fonctionner ; consultez
> [Versions de l'API](https://docs.whop.com/fr/developer/api/versioning.md) pour le contrat de stabilité.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les configurations de paiement](https://docs.whop.com/fr/api-reference/checkout-configurations/list-checkout-configurations.md) | GET `/checkout_configurations` |
| [Récupérer une configuration de paiement](https://docs.whop.com/fr/api-reference/checkout-configurations/retrieve-a-checkout-configuration.md) | GET `/checkout_configurations/{id}` |
| [Créer une configuration de paiement](https://docs.whop.com/fr/api-reference/checkout-configurations/create-a-checkout-configuration.md) | POST `/checkout_configurations` |
| [Supprimer une configuration de paiement](https://docs.whop.com/fr/api-reference/checkout-configurations/delete-a-checkout-configuration.md) | DELETE `/checkout_configurations/{id}` |

## Attributs

**id** `string` *required*

ID de la configuration de paiement, préfixé par `ch_`.

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

ID du compte, préfixé par `biz_`.

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

Code d'affiliation appliqué au paiement, ou `null` lorsqu'aucun n'est défini.

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

Date de création de la configuration de paiement, sous forme d'horodatage ISO
8601\.

**currency** `string | null`

Devise utilisée pour déterminer la disponibilité des moyens de paiement en
mode setup ; `usd` par défaut si elle est omise.

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

La configuration qui régit un paiement monté à partir de cette configuration, résolue à travers chaque niveau (ses propres remplacements, ceux de la variante et ceux du compte) — la forme que porte le `payment_method_configuration` d'une session. Appliquez-la au catalogue des types de moyens de paiement pour obtenir l'ensemble proposable. `null` signifie les valeurs par défaut de la plateforme ; `payment_method_configuration` reste le remplacement modifiable propre à cette configuration.

> [accordion] Propriétés
>
> **disabled** `string[]`
>
> Moyens de paiement explicitement désactivés.
>
> **enabled** `string[]`
>
> Moyens de paiement explicitement activés.
>
> **include\_platform\_defaults** `boolean`
>
> Indique si les moyens de paiement par défaut de la plateforme sont inclus.

**metadata** `object | null`

Métadonnées clé-valeur personnalisées copiées dans les paiements et les
adhésions. `null` sans le scope `checkout_configuration:basic:read`.

**mode** `string` *required*

Détermine si le paiement débite l'acheteur immédiatement ou enregistre les informations de paiement pour plus tard.

Options disponibles : `payment`, `setup`

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

Remplacements des moyens de paiement pour ce paiement. `null` lorsqu'il utilise les valeurs par défaut de la variante ou de la plateforme.

> [accordion] Propriétés
>
> **disabled** `string[]`
>
> Moyens de paiement explicitement désactivés pour le paiement.
>
> **enabled** `string[]`
>
> Moyens de paiement explicitement activés pour le paiement.
>
> **include\_platform\_defaults** `boolean`
>
> Indique si les moyens de paiement par défaut de la plateforme sont inclus.

**purchase\_url** `string | null`

URL de paiement que vous pouvez envoyer aux clients.

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

URL vers laquelle les clients sont redirigés après le paiement, ou `null`
lorsqu'aucune redirection n'est configurée.

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

Comportement 3D Secure pour les paiements par carte en session pris en charge. `mandate_challenge` exige un challenge 3DS avant le traitement du paiement ; `mandate_if_required` impose un challenge uniquement lorsque le processeur de paiement l'exige ; `frictionless_if_required` utilise le parcours 3DS frictionless habituel. Les paiements de 1 000 \$ ou plus utilisent `mandate_if_required` sauf si `mandate_challenge` est sélectionné. Les exigences liées au risque et à la reprise de l'authentification peuvent prévaloir sur cette préférence. S'applique en mode setup ; `null` utilise le 3DS frictionless. Le mode payment utilise la politique de la variante.

Options disponibles : `mandate_challenge`, `mandate_if_required`, `frictionless_if_required`

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

Date de dernière mise à jour de la configuration de paiement, sous forme
d'horodatage ISO 8601.

**variant** `object | null`

Variante utilisée pour le paiement. `null` en mode setup.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de la variante, préfixé par `plan_`.
>
> **adaptive\_pricing\_enabled** `boolean` *required*
>
> Indique si cette variante accepte les paiements en devise locale via la
> tarification adaptative.
>
> **billing\_period** `integer | null` *required*
>
> Intervalle de facturation récurrente en jours, par exemple 30 pour mensuel ou
> 365 pour annuel. `null` pour les variantes à paiement unique.
>
> **billing\_type** `string` *required*
>
> Modèle de facturation de la variante.
>
> Options disponibles : `renewal`, `one_time`
>
> **currency** `string` *required*
>
> Code de devise ISO à trois lettres des prix de la variante.
>
> **expiration\_days** `integer | null` *required*
>
> Durée d'accès en jours pour les variantes à expiration.
>
> **initial\_price** `number` *required*
>
> Prix d'achat initial dans la devise de la variante.
>
> **release\_method** `string` *required*
>
> Méthode de vente de la variante.
>
> Options disponibles : `buy_now`, `waitlist`
>
> **renewal\_price** `number` *required*
>
> Prix récurrent facturé à chaque période de facturation.
>
> **three\_ds\_level** `string | null` *required*
>
> Comportement 3D Secure pour les paiements par carte en session pris en charge. `mandate_challenge` exige un challenge 3DS avant le traitement du paiement ; `mandate_if_required` impose un challenge uniquement lorsque le processeur de paiement l'exige ; `frictionless_if_required` utilise le parcours 3DS frictionless habituel. Les paiements de 1 000 \$ ou plus utilisent `mandate_if_required` sauf si `mandate_challenge` est sélectionné. Les exigences liées au risque et à la reprise de l'authentification peuvent prévaloir sur cette préférence. `null` hérite de la valeur par défaut du compte.
>
> Options disponibles : `mandate_challenge`, `mandate_if_required`, `frictionless_if_required`
>
> **trial\_period\_days** `integer | null` *required*
>
> Jours d'essai gratuit avant le premier prélèvement de renouvellement.
>
> **visibility** `string` *required*
>
> Indique si la variante est visible par les clients ou masquée au public.
>
> Options disponibles : `visible`, `hidden`, `archived`, `quick_link`

```json CheckoutConfiguration theme={null}
{
	"id": "ch_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"affiliate_code": "pickaxe-partner",
	"created_at": "2026-07-01T12:00:00Z",
	"currency": "usd",
	"metadata": {
		"campaign": "summer-launch"
	},
	"mode": "payment",
	"payment_method_configuration": {
		"enabled": ["card", "apple_pay"],
		"disabled": ["crypto"],
		"include_platform_defaults": true
	},
	"effective_payment_method_configuration": {
		"enabled": ["card", "apple_pay"],
		"disabled": ["crypto"],
		"include_platform_defaults": true
	},
	"variant": {
		"id": "plan_xxxxxxxxxxxxx",
		"visibility": "visible",
		"billing_type": "renewal",
		"release_method": "buy_now",
		"currency": "usd",
		"billing_period": 30,
		"expiration_days": null,
		"initial_price": 29,
		"renewal_price": 29,
		"trial_period_days": 7,
		"three_ds_level": "frictionless_if_required",
		"adaptive_pricing_enabled": true
	},
	"purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx/?session=ch_xxxxxxxxxxxxxx",
	"redirect_url": "https://pickaxe.example/welcome",
	"three_ds_level": "frictionless_if_required",
	"updated_at": "2026-07-02T12:00:00Z"
}
```


## Related topics

- [Create checkout configuration](https://docs.whop.com/fr/api-reference/legacy/checkout-configurations/create-checkout-configuration.md)
- [List checkout configurations](https://docs.whop.com/fr/api-reference/legacy/checkout-configurations/list-checkout-configurations.md)
- [Retrieve checkout configuration](https://docs.whop.com/fr/api-reference/legacy/checkout-configurations/retrieve-checkout-configuration.md)
