Skip to main content
PATCH
Update checkout configuration

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
success_url
string | null

Full https:// URL buyers land on after paying. Pass null or "" to restore the default thank-you page.

collect_tax
boolean

Collect tax at checkout via Stripe Tax.

tax_behavior
enum<string>

Whether prices include tax (inclusive) or tax is added on top (exclusive).

Available options:
unspecified,
inclusive,
exclusive
allow_discount_codes
boolean
show_tax_id_input
boolean
show_phone_number_input
boolean
collect_shipping_address
boolean
allow_multiple_quantity
boolean | null
allowed_countries
string[]

Allow-list of ISO 3166-1 alpha-2 country codes (e.g. ["DE", "AT"]); buyers outside it are blocked at checkout. Case-insensitive. Pass [] to allow every country.

Response

Checkout configuration updated

object
string
required
allowed_countries
string[]
required

ISO 3166-1 alpha-2 allow-list; empty means every country can check out.

collect_tax
boolean
required
tax_behavior
enum<string>
required
Available options:
unspecified,
inclusive,
exclusive
tax_code
string
required
allow_discount_codes
boolean
required
show_tax_id_input
boolean
required
show_phone_number_input
boolean
required
collect_shipping_address
boolean
required
allow_multiple_quantity
boolean
required
success_url
string | null
required