Skip to main content
GET
Retrieve checkout configuration
This page documents the Legacy API. For new integrations, use Retrieve a checkout configuration in the Current API.
Required permissions:
  • checkout_configuration:basic:read

Autorisationer

Authorization
string
header
påkrævet

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

checkout_configuration:basic:read

Sti-parametre

id
string
påkrævet

The unique identifier of the checkout configuration.

Eksempel:

"ch_xxxxxxxxxxxxxxx"

Svar

A successful response

A checkout configuration is a reusable configuration for a checkout, including the plan, affiliate, and custom metadata. Payments and memberships created from a checkout session inherit its metadata.

account_id
string
påkrævet

The ID of the account to use for the checkout configuration

affiliate_code
string | null
påkrævet

The affiliate code to use for the checkout configuration

company_id
string
påkrævet

The ID of the account to use for the checkout configuration

currency
enum<string> | null
påkrævet

The currency to use for the configuration when in 'setup' mode. This is used to target which currency specific payment methods are available. If not provided, it will default to 'usd' when in setup mode.

Tilgængelige muligheder:
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
påkrævet

The unique identifier for the checkout session.

Eksempel:

"ch_xxxxxxxxxxxxxxx"

metadata
object | null
påkrævet

The metadata to use for the checkout configuration

mode
enum<string>
påkrævet

The mode of the checkout session.

Tilgængelige muligheder:
payment,
setup
payment_method_configuration
object | null
påkrævet

The explicit payment method configuration for the session, if any. This currently only works in 'setup' mode. Use the plan's payment_method_configuration for payment method.

plan
object | null
påkrævet

The plan to use for the checkout configuration

purchase_url
string
påkrævet

A URL you can send to customers to complete a checkout. It looks like /checkout/ch_xxxx/

redirect_url
string | null
påkrævet

The URL to redirect the user to after the checkout configuration is created