Choose a version:

Checkout Settings

The API for interacting with the checkout settings.

Anchor to orderstatusapiOrderStatusApi

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

Anchor to checkoutSettings checkoutSettings StatefulRemoteSubscribable<> required: Settings applied to the buyer's checkout.

Settings describing the behavior of the buyer's checkout.

orderSubmission
The type of order that will be created once the buyer completes checkout.
```
'DRAFT_ORDER' | 'ORDER'
```
paymentTermsTemplate
Represents the merchant configured payment terms.
```
PaymentTermsTemplate
```
shippingAddress
Settings describing the behavior of the shipping address.
```
ShippingAddressSettings
```

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`.
```
string
```
dueInDays
The number of days between the issued date and due date if using net payment terms.
```
number
```
id
A globally-unique ID.
```
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).
```
string
```

Settings describing the behavior of the shipping address.

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

Returns the checkoutSettings applied to the checkout.

[] | undefined

Was this page helpful?