Skip to main content
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.
Remplace la ressource Legacy Checkout configurations. Les intégrations Legacy existantes continuent de fonctionner ; consultez Versions de l’API pour le contrat de stabilité.

Endpoints

Attributs

string
requis
ID de la configuration de paiement, préfixé par ch_.
string
requis
ID du compte, préfixé par biz_.
string | null
Code d’affiliation appliqué au paiement, ou null lorsqu’aucun n’est défini.
string
requis
Date de création de la configuration de paiement, sous forme d’horodatage ISO 8601.
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.
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.

Propriétés

string[]
Moyens de paiement explicitement désactivés.
string[]
Moyens de paiement explicitement activés.
boolean
Indique si les moyens de paiement par défaut de la plateforme sont inclus.
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.
string
requis
Détermine si le paiement débite l’acheteur immédiatement ou enregistre les informations de paiement pour plus tard.Options disponibles : payment, setup
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.

Propriétés

string[]
Moyens de paiement explicitement désactivés pour le paiement.
string[]
Moyens de paiement explicitement activés pour le paiement.
boolean
Indique si les moyens de paiement par défaut de la plateforme sont inclus.
string | null
URL de paiement que vous pouvez envoyer aux clients.
string | null
URL vers laquelle les clients sont redirigés après le paiement, ou null lorsqu’aucune redirection n’est configurée.
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
string
requis
Date de dernière mise à jour de la configuration de paiement, sous forme d’horodatage ISO 8601.
object | null
Variante utilisée pour le paiement. null en mode setup.

Propriétés

string
requis
ID de la variante, préfixé par plan_.
boolean
requis
Indique si cette variante accepte les paiements en devise locale via la tarification adaptative.
integer | null
requis
Intervalle de facturation récurrente en jours, par exemple 30 pour mensuel ou 365 pour annuel. null pour les variantes à paiement unique.
string
requis
Modèle de facturation de la variante.Options disponibles : renewal, one_time
string
requis
Code de devise ISO à trois lettres des prix de la variante.
integer | null
requis
Durée d’accès en jours pour les variantes à expiration.
number
requis
Prix d’achat initial dans la devise de la variante.
string
requis
Méthode de vente de la variante.Options disponibles : buy_now, waitlist
number
requis
Prix récurrent facturé à chaque période de facturation.
string | null
requis
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
integer | null
requis
Jours d’essai gratuit avant le premier prélèvement de renouvellement.
string
requis
Indique si la variante est visible par les clients ou masquée au public.Options disponibles : visible, hidden, archived, quick_link
CheckoutConfiguration