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.

Docs_OrderStatus_CheckoutSettingsApi

checkoutSettings

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.

paymentTermsTemplate

Represents the merchant configured payment terms.

shippingAddress

Settings describing the behavior of the shipping address.

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

dueInDays

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

id

A globally-unique ID.

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

ShippingAddressSettings

Settings describing the behavior of the shipping address.

isEditable

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

useCheckoutSettings

Returns the `checkoutSettings` applied to the checkout.

UseAttributesGeneratedType

Returns the proposed `attributes` applied to the checkout.

Returns: Attribute[] | undefined

export function useAttributes< Target extends RenderOrderStatusExtensionTarget = RenderOrderStatusExtensionTarget, >(): Attribute[] | undefined { const api = useApi<Target>(); const extensionTarget = api.extension.target; if (!('attributes' in api)) { throw new ExtensionHasNoFieldError('attributes', extensionTarget); } return useSubscription(api.attributes); }