Skip to main content
In de modus payment verkoopt ze een specifieke variant; in de modus setup verzamelt en bewaart ze betaalgegevens zonder kosten in rekening te brengen. Elke configuratie kan ook overschrijven welke betaalmethoden worden geaccepteerd en hoe 3D Secure voor die checkout wordt afgedwongen. Gebruik de Checkout Configurations API om checkoutlinks aan te maken voor een bestaande of inline variant, configuraties voor een account weer te geven, de configuratie achter een checkout-URL op te halen, en links te verwijderen die niet meer gebruikt mogen worden.
Vervangt de Legacy-resource Checkout configurations. Bestaande Legacy-integraties blijven werken; zie API-versies voor het stabiliteitscontract.

Endpoints

Attributen

string
vereist
Checkoutconfiguratie-ID, met prefix ch_.
string
vereist
Account-ID, met prefix biz_.
string | null
Affiliatecode die bij de checkout wordt toegepast, of null wanneer er geen is ingesteld.
string
vereist
Wanneer de checkoutconfiguratie is aangemaakt, als ISO 8601-tijdstempel.
string | null
Valuta die wordt gebruikt voor de beschikbaarheid van betaalmethoden in de setup-modus; standaard usd wanneer weggelaten.
object | null
De configuratie die geldt voor een checkout die vanuit deze configuratie wordt geladen, bepaald via elke laag (de eigen overschrijvingen, die van de variant en die van het account) — de vorm die de payment_method_configuration van een sessie heeft. Pas deze toe op de catalogus van betaalmethodetypen om de aan te bieden set te krijgen. null betekent platformstandaarden; payment_method_configuration blijft de eigen bewerkbare overschrijving van deze configuratie.

Eigenschappen

string[]
Expliciet uitgeschakelde betaalmethoden.
string[]
Expliciet ingeschakelde betaalmethoden.
boolean
Of standaardbetaalmethoden van het platform worden meegenomen.
object | null
Aangepaste key-value-metadata die naar betalingen en lidmaatschappen wordt gekopieerd. null zonder de scope checkout_configuration:basic:read.
string
vereist
Bepaalt of de checkout de koper direct belast of betaalgegevens bewaart voor later.Beschikbare opties: payment, setup
object | null
Overschrijvingen van betaalmethoden voor deze checkout. null wanneer de standaarden van de variant of het platform worden gebruikt.

Eigenschappen

string[]
Betaalmethoden die expliciet zijn uitgeschakeld voor de checkout.
string[]
Betaalmethoden die expliciet zijn ingeschakeld voor de checkout.
boolean
Of standaardbetaalmethoden van het platform worden meegenomen.
string | null
Checkout-URL die je naar klanten kunt sturen.
string | null
URL waarnaar klanten na de checkout worden gestuurd, of null wanneer er geen doorverwijzing is ingesteld.
string | null
3D Secure-gedrag voor ondersteunde on-session kaartbetalingen. mandate_challenge vereist een 3DS-challenge vóór de verwerking van de betaling; mandate_if_required verplicht een challenge alleen wanneer de betalingsverwerker dat vereist; frictionless_if_required gebruikt de gewone frictionless 3DS-flow. Betalingen van $1,000 of meer gebruiken mandate_if_required, tenzij mandate_challenge is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. Geldt in de setup-modus; null gebruikt frictionless 3DS. De payment-modus gebruikt het beleid van de variant.Beschikbare opties: mandate_challenge, mandate_if_required, frictionless_if_required
string
vereist
Wanneer de checkoutconfiguratie voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
object | null
Variant die wordt gebruikt voor de betaalcheckout. null in de setup-modus.

Eigenschappen

string
vereist
Variant-ID, met prefix plan_.
boolean
vereist
Of deze variant betalingen in lokale valuta accepteert via adaptive pricing.
integer | null
vereist
Terugkerend factureringsinterval in dagen, zoals 30 voor maandelijks of 365 voor jaarlijks. null voor eenmalige varianten.
string
vereist
Factureringsmodel voor de variant.Beschikbare opties: renewal, one_time
string
vereist
ISO-valutacode van drie letters voor de prijzen van de variant.
integer | null
vereist
Toegangsduur in dagen voor varianten op basis van een vervaldatum.
number
vereist
Initiële aankoopprijs in de valuta van de variant.
string
vereist
Verkoopmethode voor de variant.Beschikbare opties: buy_now, waitlist
number
vereist
Terugkerende prijs die elke factureringsperiode in rekening wordt gebracht.
string | null
vereist
3D Secure-gedrag voor ondersteunde on-session kaartbetalingen. mandate_challenge vereist een 3DS-challenge vóór de verwerking van de betaling; mandate_if_required verplicht een challenge alleen wanneer de betalingsverwerker dat vereist; frictionless_if_required gebruikt de gewone frictionless 3DS-flow. Betalingen van $1,000 of meer gebruiken mandate_if_required, tenzij mandate_challenge is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. null neemt de standaardinstelling van het account over.Beschikbare opties: mandate_challenge, mandate_if_required, frictionless_if_required
integer | null
vereist
Aantal gratis proefdagen vóór de eerste verlengingsbetaling.
string
vereist
Of de variant zichtbaar is voor klanten of verborgen is voor het publiek.Beschikbare opties: visible, hidden, archived, quick_link
CheckoutConfiguration