> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Get Checkout Settings

GET https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settings

Returns the store-level checkout settings, including checkout type, guest checkout rules, privacy policy consent, order terms and conditions, and custom checkout script and style overrides.

A channel can override most of these settings. See [Get Channel-Specific Checkout Settings](/developer/api-reference/rest/admin/management/checkouts/settings/get-channel-checkout-settings).

Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/checkouts/settings/get-checkout-settings

## Authentication

- `X-Auth-Token` header (required) — ### 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

### Path parameters

- `store_hash` (string, required) — Permanent ID of the BigCommerce store.

### Headers

- `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

## Response

### 200

OK

- `data` (CheckoutsSettings, optional) — The store-level checkout settings.
- `meta` (MetaOpen, optional) — Response metadata.

## Types

### CheckoutsSettings

The store-level checkout settings.

- `checkout_type` (enum, optional) — The checkout type. `optimized` uses Optimized One-Page Checkout. `custom` loads the script at `custom_checkout_script_url`, which must be set when the type is `custom`. Setting a non-empty `custom_checkout_script_url` while the type is `optimized` returns a 422.
  - Allowed values: `optimized`, `custom`
- `guest_checkout_type` (enum, optional) — How guest shoppers can check out. `guest_checkout` allows guest checkout. `guest_checkout_account` allows guest checkout and creates a customer account when the order completes. `no_guest_checkout` requires shoppers to sign in.
  - Allowed values: `guest_checkout`, `guest_checkout_account`, `no_guest_checkout`
- `guest_checkout_for_existing_accounts` (enum, optional) — How checkout treats a guest whose email matches an existing customer account. `allow_guest` lets them continue as a guest. `require_login` makes them sign in. `encourage_login` prompts them to sign in but lets them continue as a guest. When `guest_checkout_type` is `no_guest_checkout`, the channel-level value is set to `require_login`.
  - Allowed values: `allow_guest`, `require_login`, `encourage_login`
- `custom_checkout_script_url` (string, optional) — Custom checkout script URL to replace the default checkout. Accepts an `https` URL or a `webdav:` path to a file uploaded with WebDAV. To reset a store to Optimized One-Page Checkout, pass an empty string for `custom_checkout_script_url` and `custom_order_confirmation_script_url`.
- `policy_consent` (enum, optional) — How checkout collects privacy policy consent. `none` does not show a privacy policy. `standard` shows the privacy policy. `express` requires the shopper to actively consent before placing the order.
  - Allowed values: `none`, `standard`, `express`
- `order_confirmation_contact_email` (string, optional) — The contact email address shown on the order confirmation page.
- `order_confirmation_use_custom_checkout_script` (boolean, optional) — Whether the order confirmation page loads the same script as the custom checkout. When `true`, `custom_order_confirmation_script_url` defaults to an empty string.
- `custom_order_confirmation_script_url` (string, optional) — Custom order confirmation script URL to replace the default order confirmation page. Accepts an `https` URL or a `webdav:` path. To reset a store to Optimized One-Page Checkout, pass an empty string for `custom_checkout_script_url` and `custom_order_confirmation_script_url`.
- `is_order_terms_and_conditions_enabled` (boolean, optional) — Whether shoppers must accept order terms and conditions before placing an order. When `true`, `order_terms_and_conditions_type` is required, and the matching `order_terms_and_conditions_link` or `order_terms_and_conditions_textarea` must not be empty.
- `order_terms_and_conditions_type` (enum, optional) — How the terms and conditions display at checkout. `link` links to the page at `order_terms_and_conditions_link`. `textarea` shows the text in `order_terms_and_conditions_textarea`. Returns an empty string when terms and conditions are not configured.
  - Allowed values: `link`, `textarea`, ``
- `order_terms_and_conditions_link` (string, optional) — The URL of the terms and conditions page. Used when `order_terms_and_conditions_type` is `link`.
- `order_terms_and_conditions_textarea` (string, optional) — The terms and conditions text shown at checkout. Used when `order_terms_and_conditions_type` is `textarea`.
- `custom_checkout_supports_uco_settings` (boolean, optional, nullable) — Whether the custom checkout supports Optimized One-Page Checkout settings from the control panel.
- `custom_checkout_supports_data_hydration` (boolean, optional) — Whether the custom checkout receives the checkout's initial state when it loads, instead of fetching it after load. Takes effect only when initial-state hydration for custom checkouts is enabled for the store.
- `should_redirect_to_storefront_for_auth` (boolean, optional) — Whether checkout redirects shoppers to the storefront to sign in, so a headless storefront keeps the customer session in sync. Set to `true` for Catalyst and other headless storefronts that manage customer authentication.
- `support_b2b_settings` (boolean, optional) — Whether checkout applies B2B Edition settings, such as company account rules. Returned only for stores where B2B checkout settings are enabled.
- `custom_checkout_sri_hash` (string, optional) — The Subresource Integrity (SRI) hash for the custom checkout script. Accepts a `sha256-`, `sha384-`, or `sha512-` hash, or an empty string to remove the hash.
- `custom_order_confirmation_sri_hash` (string, optional) — The Subresource Integrity (SRI) hash for the custom order confirmation script. Accepts a `sha256-`, `sha384-`, or `sha512-` hash, or an empty string to remove the hash.
- `checkout_style_override` (string, optional, nullable) — URL of a CSS file that overrides the Optimized One-Page Checkout styles. Accepts an `https` URL or a `webdav:` path that ends in `.css`. Pass an empty string to remove the override.
- `checkout_style_override_sri_hash` (string, optional) — The Subresource Integrity (SRI) hash for the stylesheet at `checkout_style_override`. Accepts a `sha256-`, `sha384-`, or `sha512-` hash, or an empty string when no hash is set.
- `enhanced_checkout_experience` (boolean, optional) — Whether the Enhanced Checkout experience is enabled in the control panel. Read-only. Change it under **Settings > Checkout** in the control panel.

### MetaOpen

Response metadata.

## Examples

### Response

**Response**

```json
{
  "data": {
    "checkout_type": "optimized",
    "guest_checkout_type": "guest_checkout",
    "guest_checkout_for_existing_accounts": "allow_guest",
    "custom_checkout_script_url": "",
    "policy_consent": "none",
    "order_confirmation_contact_email": "orders@example.com",
    "order_confirmation_use_custom_checkout_script": false,
    "custom_order_confirmation_script_url": "",
    "is_order_terms_and_conditions_enabled": false,
    "order_terms_and_conditions_type": "",
    "order_terms_and_conditions_link": "",
    "order_terms_and_conditions_textarea": "",
    "custom_checkout_supports_uco_settings": null,
    "custom_checkout_supports_data_hydration": false,
    "should_redirect_to_storefront_for_auth": false,
    "support_b2b_settings": false,
    "custom_checkout_sri_hash": "",
    "custom_order_confirmation_sri_hash": "",
    "checkout_style_override": null,
    "checkout_style_override_sri_hash": "",
    "enhanced_checkout_experience": false
  },
  "meta": {}
}
```

**SDK Code**

```python Response
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings"

headers = {
    "Accept": "application/json",
    "X-Auth-Token": "<apiKey>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Response
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings';
const options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-Auth-Token': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("X-Auth-Token", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Response
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["X-Auth-Token"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")
  .header("Accept", "application/json")
  .header("X-Auth-Token", "<apiKey>")
  .asString();
```

```php Response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings', [
  'headers' => [
    'Accept' => 'application/json',
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Response
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("X-Auth-Token", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Response
import Foundation

let headers = [
  "Accept": "application/json",
  "X-Auth-Token": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### WebDAV protocol

**Response**

```json
{
  "data": {
    "checkout_type": "custom",
    "guest_checkout_type": "guest_checkout",
    "guest_checkout_for_existing_accounts": "allow_guest",
    "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js",
    "policy_consent": "none",
    "order_confirmation_contact_email": "orders@example.com",
    "order_confirmation_use_custom_checkout_script": false,
    "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js",
    "is_order_terms_and_conditions_enabled": false,
    "order_terms_and_conditions_type": "",
    "order_terms_and_conditions_link": "",
    "order_terms_and_conditions_textarea": "",
    "custom_checkout_supports_uco_settings": false,
    "custom_checkout_supports_data_hydration": false,
    "should_redirect_to_storefront_for_auth": false,
    "support_b2b_settings": false,
    "custom_checkout_sri_hash": "",
    "custom_order_confirmation_sri_hash": "",
    "checkout_style_override": null,
    "checkout_style_override_sri_hash": "",
    "enhanced_checkout_experience": false
  },
  "meta": {}
}
```

**SDK Code**

```python WebDAV protocol
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings"

headers = {
    "Accept": "application/json",
    "X-Auth-Token": "<apiKey>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript WebDAV protocol
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings';
const options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-Auth-Token': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go WebDAV protocol
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("X-Auth-Token", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby WebDAV protocol
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["X-Auth-Token"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java WebDAV protocol
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")
  .header("Accept", "application/json")
  .header("X-Auth-Token", "<apiKey>")
  .asString();
```

```php WebDAV protocol
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings', [
  'headers' => [
    'Accept' => 'application/json',
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp WebDAV protocol
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("X-Auth-Token", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift WebDAV protocol
import Foundation

let headers = [
  "Accept": "application/json",
  "X-Auth-Token": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```