Skip to main content
I payment-tilstand sælger den en bestemt variant; i setup-tilstand indsamler og gemmer den betalingsoplysninger uden at opkræve. Hver konfiguration kan også tilsidesætte, hvilke betalingsmetoder der accepteres, og hvordan 3D Secure håndhæves for den pågældende checkout. Brug Checkout Configurations API’et til at oprette checkout-links til en eksisterende eller inline variant, liste konfigurationer for en konto, hente konfigurationen bag en checkout-URL og slette links, der ikke længere skal bruges.
Erstatter Legacy-ressourcen Checkout configurations. Eksisterende Legacy-integrationer fortsætter med at virke; se API-versioner for stabilitetsaftalen.

Endpoints

Attributter

string
påkrævet
Checkout-konfigurations-ID med præfikset ch_.
string
påkrævet
Konto-ID med præfikset biz_.
string | null
Affiliate-kode anvendt ved checkout, eller null, når ingen er angivet.
string
påkrævet
Hvornår checkout-konfigurationen blev oprettet, som et ISO 8601-tidsstempel.
string | null
Valuta brugt til tilgængelighed af betalingsmetoder i setup-tilstand; standard er usd, når den udelades.
object | null
Konfigurationen, der styrer en checkout monteret fra denne konfiguration, afledt gennem alle lag (dens egne tilsidesættelser, variantens og kontoens) — den form, en sessions payment_method_configuration har. Anvend den oven på kataloget over betalingsmetodetyper for at få det tilbudte sæt. null betyder platformens standarder; payment_method_configuration forbliver denne konfigurations egen redigerbare tilsidesættelse.

Egenskaber

string[]
Betalingsmetoder, der eksplicit er deaktiveret.
string[]
Betalingsmetoder, der eksplicit er aktiveret.
boolean
Om platformens standardbetalingsmetoder er inkluderet.
object | null
Brugerdefinerede nøgle-værdi-metadata kopieret til betalinger og medlemskaber. null uden scopet checkout_configuration:basic:read.
string
påkrævet
Styrer, om checkout opkræver køberen med det samme eller gemmer betalingsoplysninger til senere.Tilgængelige muligheder: payment, setup
object | null
Tilsidesættelser af betalingsmetoder for denne checkout. null, når den bruger variantens eller platformens standarder.

Egenskaber

string[]
Betalingsmetoder, der eksplicit er deaktiveret for checkout.
string[]
Betalingsmetoder, der eksplicit er aktiveret for checkout.
boolean
Om platformens standardbetalingsmetoder er inkluderet.
string | null
Checkout-URL, du kan sende til kunder.
string | null
URL, kunder sendes til efter checkout, eller null, når der ikke er konfigureret en omdirigering.
string | null
3D Secure-adfærd for understøttede on-session-kortbetalinger. mandate_challenge kræver en 3DS-udfordring før betalingsbehandling; mandate_if_required kræver kun en udfordring, når betalingsbehandleren kræver det; frictionless_if_required bruger det almindelige friktionsfri 3DS-flow. Betalinger på $1.000 eller mere bruger mandate_if_required, medmindre mandate_challenge er valgt. Krav til risiko og genopretning af godkendelse kan tilsidesætte præferencen. Gælder i setup-tilstand; null bruger friktionsfri 3DS. Betalingstilstand bruger variantens politik.Tilgængelige muligheder: mandate_challenge, mandate_if_required, frictionless_if_required
string
påkrævet
Hvornår checkout-konfigurationen sidst blev opdateret, som et ISO 8601-tidsstempel.
object | null
Variant brugt til betalings-checkout. null i setup-tilstand.

Egenskaber

string
påkrævet
Variant-ID med præfikset plan_.
boolean
påkrævet
Om denne variant accepterer betalinger i lokal valuta via adaptiv prissætning.
integer | null
påkrævet
Tilbagevendende faktureringsinterval i dage, f.eks. 30 for månedlig eller 365 for årlig. null for engangsvarianter.
string
påkrævet
Faktureringsmodel for varianten.Tilgængelige muligheder: renewal, one_time
string
påkrævet
Trebogstavs ISO-valutakode for variantens priser.
integer | null
påkrævet
Adgangsvarighed i dage for udløbsbaserede varianter.
number
påkrævet
Indledende købspris i variantens valuta.
string
påkrævet
Salgsmetode for varianten.Tilgængelige muligheder: buy_now, waitlist
number
påkrævet
Tilbagevendende pris opkrævet hver faktureringsperiode.
string | null
påkrævet
3D Secure-adfærd for understøttede on-session-kortbetalinger. mandate_challenge kræver en 3DS-udfordring før betalingsbehandling; mandate_if_required kræver kun en udfordring, når betalingsbehandleren kræver det; frictionless_if_required bruger det almindelige friktionsfri 3DS-flow. Betalinger på $1.000 eller mere bruger mandate_if_required, medmindre mandate_challenge er valgt. Krav til risiko og genopretning af godkendelse kan tilsidesætte præferencen. null arver kontoens standard.Tilgængelige muligheder: mandate_challenge, mandate_if_required, frictionless_if_required
integer | null
påkrævet
Gratis prøvedage før den første fornyelsesopkrævning.
string
påkrævet
Om varianten er synlig for kunder eller skjult fra offentligheden.Tilgængelige muligheder: visible, hidden, archived, quick_link
CheckoutConfiguration