Update Checkout Settings | BigCommerce Developer Center

Update checkout settings

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Checkouts	modify	`store_checkouts`
Checkouts	read-only	`store_checkouts_read_only`
Checkout Content	modify	`store_checkout_content`
Checkout Content	read-only	`store_checkout_content_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Checkouts | modify | `store_checkouts` | | Checkouts | read-only | `store_checkouts_read_only` | | Checkout Content | modify | `store_checkout_content` | | Checkout Content | read-only | `store_checkout_content_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects an object.

custom_checkout_script_urlstringOptional

Custom checkout script URL to replace our default checkout. To reset a store to optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.

order_confirmation_use_custom_checkout_scriptbooleanOptional

When order_confirmation_use_custom_checkout_script=true, the default custom_order_confirmation_script_url defaults to an empty string.

custom_order_confirmation_script_urlstringOptional

Custom order confirmation script URL to replace the default order confirmation. To reset a store to optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.

custom_checkout_supports_uco_settingsbooleanOptional

Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.

custom_checkout_sri_hashstringOptional

The Subresource Integrity (SRI) hash for the custom checkout script URL.

custom_order_confirmation_sri_hashstringOptional

The Subresource Integrity (SRI) hash for the custom order confirmation script URL.

Response

dataobject

metaobject

Response metadata.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings"
4
5	payload = {}
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"data": {
3	"custom_checkout_script_url": "https://example.com/custom-checkout-script.js",
4	"order_confirmation_use_custom_checkout_script": false,
5	"custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js",
6	"custom_checkout_supports_uco_settings": false,
7	"custom_checkout_sri_hash": "sha256-1234567890",
8	"order_confirmation_sri_hash": "sha256-0987654321"
9	},
10	"meta": {}
11	}