> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetCheckoutSettings

# Package: checkout

# Namespace: CheckoutSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/checkout-settings/get-checkout-settings.md

## Permission Scopes:
Read Orders: SCOPE.DC-STORES.READ-ORDERS

## Introduction

Retrieves the site's checkout settings.

---

## REST API

### Schema

```
 Method: getCheckoutSettings
 Description: Retrieves the site's checkout settings.
 URL: https://www.wixapis.com/ecom/v1/checkout-settings
 Method: GET
 Return type: GetCheckoutSettingsResponse
  - name: checkoutSettings | type: CheckoutSettings | description: Checkout settings. 
     - name: checkoutPolicies | type: CheckoutPolicies | description: Checkout policies. 
        - name: termsAndConditions | type: TermsAndConditionsPolicy | description: Terms and conditions. 
           - name: visible | type: boolean | description: Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Terms and conditions policy content. 
        - name: privacyPolicy | type: PrivacyPolicy | description: Privacy policy. 
           - name: visible | type: boolean | description: Whether the privacy policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Privacy policy content. 
        - name: returnPolicy | type: ReturnPolicy | description: Return policy. 
           - name: visible | type: boolean | description: Whether the return policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Return policy content. 
        - name: digitalItemPolicy | type: DigitalItemPolicy | description: Digital item policy. 
           - name: visible | type: boolean | description: Whether the digital item policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Digital item policy content. 
        - name: contactUs | type: ContactUsPolicy | description: "Contact us" information. 
           - name: visible | type: boolean | description: Whether the contact us policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Contact us policy content. 
        - name: customPolicy | type: CustomCheckoutPolicy | description: Custom policy. 
           - name: visible | type: boolean | description: Whether the custom policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Custom policy content. 
           - name: title | type: string | description: Custom policy title. 
     - name: checkoutFields | type: CheckoutFields | description: Settings that apply to checkout fields and the checkout process. 
        - name: subscriptionCheckbox | type: CheckboxField | description: Subscription checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false` 
           - name: visible | type: boolean | description: Whether the checkbox is visible to the customer. 
           - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default. 
        - name: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false` 
        - name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled. <br><br>  Default: `false` 
        - name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions. <br><br>  Default: `false` 
        - name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions. <br><br>  Default: `false` 
        - name: captureBeforeExpiryEnabled | type: boolean | description: Whether to automatically capture the transaction before the authorization expires.  Default: `true` >**Note:** this setting is only relevant when `delay_capture_enabled: true`. 
     - name: checkoutBrand | type: CheckoutBrand | description: Checkout brand settings. 
        - name: header | type: CheckoutHeader | description: Checkout header. 
           - name: text | type: string | description: Textual content to be included in the header (e.g. Business Name) 
           - name: textColor | type: string | description: Text color hex code. 
           - name: logo | type: Logo | description: Specifications for when a logo is included in the header. 
              - name: size | type: LogoSize | description: Size of the logo. 
                     - enum: SMALL, MEDIUM, LARGE
           - name: alignment | type: Alignment | description: Alignment within the header.  >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left. 
                 - enum: SIDE, CENTER
           - name: displayCheckoutLabel | type: boolean | description: Whether to display the 'Checkout' label within the header. Depending on the locale, the label may be translated. 
           - name: continueShopping | type: ContinueShopping | description: Continue shopping specifications. 
              - name: hidden | type: boolean | description: Whether the continue shopping element is hidden. 
              - name: displayType | type: DisplayType | description: Display type for the continue shopping element. 
                     - enum: TEXT, ICON
           - name: backgroundFill | type: BackgroundFill | description: Background fill specifications. 
              - ONE-OF: 
                 - name: color | type: string | description: Background color hex code. 
                 - name: image | type: Image | description: Background image. 
                    - name: id | type: string | description: WixMedia image GUID. 
                    - name: url | type: string | description: Image URL. 
                    - name: height | type: integer | description: Original image height. 
                    - name: width | type: integer | description: Original image width. 
                    - name: altText | type: string | description: Image alt text. 
                    - name: filename | type: string | description: Image filename. 
     - name: createdDate | type: string | description: Date and time the checkout settings were created. 
     - name: updatedDate | type: string | description: Date and time the checkout settings were updated. 
     - name: checkoutBillingFields | type: CheckoutBillingFields | description: Billing information required to complete the checkout. 
         - enum:
         -     All_FIELDS: All billing information fields are required.
         -     MINIMUM_REQUIRED_FIELDS: Minimum required fields as defined by the country, payment method and payment provider.


```

### Examples

### Get checkout settings
```curl
curl -X GET \
  'https://www.wixapis.com/ecom/v1/checkout-settings' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.checkout.CheckoutSettingsService.getCheckoutSettings()
 Description: Retrieves the site's checkout settings.
 Return type: PROMISE<GetCheckoutSettingsResponse>
  - name: checkoutSettings | type: CheckoutSettings | description: Checkout settings. 
     - name: checkoutPolicies | type: CheckoutPolicies | description: Checkout policies. 
        - name: termsAndConditions | type: TermsAndConditionsPolicy | description: Terms and conditions. 
           - name: visible | type: boolean | description: Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Terms and conditions policy content. 
        - name: privacyPolicy | type: PrivacyPolicy | description: Privacy policy. 
           - name: visible | type: boolean | description: Whether the privacy policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Privacy policy content. 
        - name: returnPolicy | type: ReturnPolicy | description: Return policy. 
           - name: visible | type: boolean | description: Whether the return policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Return policy content. 
        - name: digitalItemPolicy | type: DigitalItemPolicy | description: Digital item policy. 
           - name: visible | type: boolean | description: Whether the digital item policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Digital item policy content. 
        - name: contactUs | type: ContactUsPolicy | description: "Contact us" information. 
           - name: visible | type: boolean | description: Whether the contact us policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Contact us policy content. 
        - name: customPolicy | type: CustomCheckoutPolicy | description: Custom policy. 
           - name: visible | type: boolean | description: Whether the custom policy is visible to the customer in the checkout page. <br><br>  Default: `false` 
           - name: content | type: string | description: Custom policy content. 
           - name: title | type: string | description: Custom policy title. 
     - name: checkoutFields | type: CheckoutFields | description: Settings that apply to checkout fields and the checkout process. 
        - name: subscriptionCheckbox | type: CheckboxField | description: Subscription checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false` 
           - name: visible | type: boolean | description: Whether the checkbox is visible to the customer. 
           - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default. 
        - name: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false` 
        - name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled. <br><br>  Default: `false` 
        - name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions. <br><br>  Default: `false` 
        - name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions. <br><br>  Default: `false` 
        - name: captureBeforeExpiryEnabled | type: boolean | description: Whether to automatically capture the transaction before the authorization expires.  Default: `true` >**Note:** this setting is only relevant when `delay_capture_enabled: true`. 
     - name: checkoutBrand | type: CheckoutBrand | description: Checkout brand settings. 
        - name: header | type: CheckoutHeader | description: Checkout header. 
           - name: text | type: string | description: Textual content to be included in the header (e.g. Business Name) 
           - name: textColor | type: string | description: Text color hex code. 
           - name: logo | type: Logo | description: Specifications for when a logo is included in the header. 
              - name: size | type: LogoSize | description: Size of the logo. 
                     - enum: SMALL, MEDIUM, LARGE
           - name: alignment | type: Alignment | description: Alignment within the header.  >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left. 
                 - enum: SIDE, CENTER
           - name: displayCheckoutLabel | type: boolean | description: Whether to display the 'Checkout' label within the header. Depending on the locale, the label may be translated. 
           - name: continueShopping | type: ContinueShopping | description: Continue shopping specifications. 
              - name: hidden | type: boolean | description: Whether the continue shopping element is hidden. 
              - name: displayType | type: DisplayType | description: Display type for the continue shopping element. 
                     - enum: TEXT, ICON
           - name: backgroundFill | type: BackgroundFill | description: Background fill specifications. 
              - ONE-OF: 
                 - name: color | type: string | description: Background color hex code. 
                 - name: image | type: string | description: Background image. 
     - name: _createdDate | type: Date | description: Date and time the checkout settings were created. 
     - name: _updatedDate | type: Date | description: Date and time the checkout settings were updated. 
     - name: checkoutBillingFields | type: CheckoutBillingFields | description: Billing information required to complete the checkout. 
         - enum:
         -     All_FIELDS: All billing information fields are required.
         -     MINIMUM_REQUIRED_FIELDS: Minimum required fields as defined by the country, payment method and payment provider.


```

### Examples

### Get checkout settings with elevated permissions
```javascript
import { checkoutSettings } from '@wix/ecom';
import { auth } from '@wix/essentials';

const elevatedGetCheckoutSettings = auth.elevate(checkoutSettings.getCheckoutSettings);

export async function myGetCheckoutSettingsFunction() {
  try { 
    const getCheckoutSettings = await elevatedGetCheckoutSettings();
    console.log('Success! Checkout settings:', getCheckoutSettings);
    return getCheckoutSettings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}
/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/

```

### Get checkout settings
```javascript
import { checkoutSettings } from '@wix/ecom';

export async function myGetCheckoutSettingsFunction() {
  try {
    const settings = await checkoutSettings.getCheckoutSettings();
    console.log('Success! CheckoutSettings:', settings);
    return settings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/

```

### getCheckoutSettings (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { checkoutSettings },
  // Include the auth strategy and host as relevant
});


async function getCheckoutSettings() {
  const response = await myWixClient.checkoutSettings.getCheckoutSettings();
};
```

---