---
title: Checkout Settings
description: The API for interacting with the checkout settings.
api_version: 2024-10
api_name: customer-account-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/checkout-settings
  md: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/checkout-settings.md
---

# Checkout Settings

The API for interacting with the checkout settings.

## OrderStatusApi

The API object provided to this and other `customer-account.order-status` extension targets.

* checkoutSettings

  StatefulRemoteSubscribable\<CheckoutSettings>

  required

  Settings applied to the buyer's checkout.

### 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.

* 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
  ```

* 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
  ```

```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;
}
```

## use​Attributes()

Returns the `checkoutSettings` applied to the checkout.

### Returns

* Attribute\[] | undefined

### Attribute

* key

  The key for the attribute.

  ```ts
  string
  ```

* value

  The value for the attribute.

  ```ts
  string
  ```

```ts
export interface Attribute {
  /**
   * The key for the attribute.
   */
  key: string;

  /**
   * The value for the attribute.
   */
  value: string;
}
```