---
title: useCheckoutSettings
description: Returns the `checkoutSettings` applied to the checkout.
api_version: 2023-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/metadata/usecheckoutsettings
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/metadata/usecheckoutsettings.md
---

# use​Checkout​Settingshook

Returns the `checkoutSettings` applied to the checkout.

## use​Checkout​Settings()

### Returns

* CheckoutSettings

  ### CheckoutSettings

  * orderSubmission

    "DRAFT\_ORDER" | "ORDER"

    The type of order that will be created once the buyer completes checkout.

  * shippingAddress

    ShippingAddressSettings

    Settings describing the behavior of the shipping address.

  * paymentTermsTemplate

    PaymentTermsTemplate

    Represents the merchant configured payment terms.

### CheckoutSettings

Settings describing the behavior of the buyer's checkout.

* orderSubmission

  The type of order that will be created once the buyer completes checkout.

  ```ts
  "DRAFT_ORDER" | "ORDER"
  ```

* paymentTermsTemplate

  Represents the merchant configured payment terms.

  ```ts
  PaymentTermsTemplate
  ```

* shippingAddress

  Settings describing the behavior of the shipping address.

  ```ts
  ShippingAddressSettings
  ```

```ts
export interface CheckoutSettings {
  /**
   * The type of order that will be created once the buyer completes checkout.
   */
  orderSubmission: 'DRAFT_ORDER' | 'ORDER';
  /**
   * Represents the merchant configured payment terms.
   */
  paymentTermsTemplate?: PaymentTermsTemplate;
  /**
   * Settings describing the behavior of the shipping address.
   */
  shippingAddress: ShippingAddressSettings;
}
```

### PaymentTermsTemplate

Represents the payment terms template object.

* id

  A globally-unique ID.

  ```ts
  string
  ```

* name

  The name of the payment terms translated to the buyer's current language. See \[localization.language]\(/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-localization).

  ```ts
  string
  ```

* dueDate

  The due date for net payment terms as a ISO 8601 formatted string \`YYYY-MM-DDTHH:mm:ss.sssZ\`.

  ```ts
  string
  ```

* dueInDays

  The number of days between the issued date and due date if using net payment terms.

  ```ts
  number
  ```

```ts
export interface PaymentTermsTemplate {
  /**
   * A globally-unique ID.
   * @example 'gid://shopify/PaymentTermsTemplate/1'
   */
  id: string;
  /**
   * The name of the payment terms translated to the buyer's current language. See [localization.language](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-localization).
   */
  name: string;
  /**
   * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`.
   */
  dueDate?: string;
  /**
   * The number of days between the issued date and due date if using net payment terms.
   */
  dueInDays?: number;
}
```

### ShippingAddressSettings

Settings describing the behavior of the shipping address.

* isEditable

  Describes whether the buyer can ship to any address during checkout.

  ```ts
  boolean
  ```

```ts
export interface ShippingAddressSettings {
  /**
   * Describes whether the buyer can ship to any address during checkout.
   */
  isEditable: boolean;
}
```

## Related

[APIs - StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)

[APIs - CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)

[APIs - OrderStatusApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)

[APIs - CartLineItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlineitemapi)

[APIs - PickupPointListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)

[APIs - PickupLocationListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)

[APIs - ShippingOptionItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)

[APIs - ExtensionTargets](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets)