CheckoutConfiguration

Update checkout configuration

Partially updates the account-wide checkout settings; only the fields sent change. allowed_countries is an allow-list of ISO 3166-1 alpha-2 codes (["US", "CA"] lets only US and Canadian buyers through) — send [] to lift the restriction, never the full list of countries. success_url must be a full https:// URL; send null or "" to restore the default thank-you page. Saving expires every open checkout session and re-syncs the account's Stripe Tax settings.

patch/checkout_configuration

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/checkout_configuration
  • Auth: API key in header Authorization

Request body

success_urlstring nullable

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

collect_taxboolean

Collect tax at checkout via Stripe Tax.

tax_behavior'unspecified' | 'inclusive' | 'exclusive'

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

allow_discount_codesboolean
show_tax_id_inputboolean
show_phone_number_inputboolean
collect_call_consentboolean
collect_shipping_addressboolean
allow_multiple_quantityboolean nullable
allowed_countriesstring[]

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

objectstring required
allowed_countriesstring[] required

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

collect_taxboolean required
tax_behavior'unspecified' | 'inclusive' | 'exclusive' required
tax_codestring required
allow_discount_codesboolean required
show_tax_id_inputboolean required
show_phone_number_inputboolean required
collect_call_consentboolean required
collect_shipping_addressboolean required
allow_multiple_quantityboolean required
success_urlstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.