items CartLine[] [] Name items Description The order's lines, listed in the summary.
Type CartLine[] Default [] defaultValues Partial < CheckoutValues > — Name defaultValues Description Prefills the form, e.g. with a signed-in shopper's address.
Type Partial < CheckoutValues > Default — currency string 'EUR' Name currency Description ISO 4217 code for the totals while there are no items; otherwise the first item's currency.
Type string Default 'EUR' locale string — Name locale Description BCP 47 locale the prices are formatted in; the ConfigProvider's when left out.
Type string Default — storeName string '' Name storeName Description Shown as the store's name above the form when no logo slot is given; nothing shows when both are empty.
Type string Default '' countries CheckoutOption[] [
{ value : 'DE' , label : 'Germany' },
{ value : 'AT' , label : 'Austria' },
{ value : 'CH' , label : 'Switzerland' },
{ value : 'GB' , label : 'United Kingdom' },
{ value : 'US' , label : 'United States' },
] Name countries Description The choices in the country selects; value is the country code the form sends.
Type CheckoutOption[] Default [
{ value : 'DE' , label : 'Germany' },
{ value : 'AT' , label : 'Austria' },
{ value : 'CH' , label : 'Switzerland' },
{ value : 'GB' , label : 'United Kingdom' },
{ value : 'US' , label : 'United States' },
] defaultCountry string 'DE' Name defaultCountry Description The country selected at first, by value ; defaultValues . country takes precedence.
Type string Default 'DE' houseNumberCountries string [] [ 'DE' , 'AT' , 'CH' , 'NL' ] Name houseNumberCountries Description Countries, by value , whose addresses ask for the building number in a field of its own.
Type string [] Default [ 'DE' , 'AT' , 'CH' , 'NL' ] shippingMethods ShippingMethod[] [
{ value : 'standard' , label : 'Standard' , description : '3 to 5 working days' , amount : 499 , freeFrom : 10000 },
{ value : 'express' , label : 'Express' , description : 'Next working day' , amount : 1290 },
] Name shippingMethods Description The shipping methods offered once the address is complete.
Type ShippingMethod[] Default [
{ value : 'standard' , label : 'Standard' , description : '3 to 5 working days' , amount : 499 , freeFrom : 10000 },
{ value : 'express' , label : 'Express' , description : 'Next working day' , amount : 1290 },
] paymentMethods PaymentMethod[] [
{ value : 'card' , label : 'Credit card' },
{ value : 'paypal' , label : 'PayPal' , description : 'After you click Pay now, PayPal opens to finish your purchase.' },
] Name paymentMethods Description The payment methods, one row each; picking one reveals its details.
Type PaymentMethod[] Default [
{ value : 'card' , label : 'Credit card' },
{ value : 'paypal' , label : 'PayPal' , description : 'After you click Pay now, PayPal opens to finish your purchase.' },
] cardMethod string 'card' Name cardMethod Description The payment method, by value , that reveals the card fields.
Type string Default 'card' discounts AppliedDiscount[] [] Name discounts Description Codes and gift cards on the order, each a removable badge and taken off the total.
Type AppliedDiscount[] Default [] taxRate number — Name taxRate Description The tax rate included in the prices, e.g. 0.19 ; the total's tax note hides when left out.
Type number Default — signInHref string — Name signInHref Description Where the sign-in link beside the contact heading goes; the link hides when left out.
Type string Default — policyLinks PolicyLink[] [] Name policyLinks Description Links under the pay button, e.g. the refund and privacy policies.
Type PolicyLink[] Default [] secureLabel string 'Secure checkout' Name secureLabel Description Shown beside the store name, e.g. that the checkout is encrypted; hidden when empty.
Type string Default 'Secure checkout' contactTitle string 'Contact' Name contactTitle Description Shown as the contact card's heading.
Type string Default 'Contact' contactDescription string 'We send the order confirmation here.' Name contactDescription Description Shown under the contact card's heading; hidden when empty.
Type string Default 'We send the order confirmation here.' signInLabel string 'Sign in' Name signInLabel Description Shown on the sign-in link.
Type string Default 'Sign in' emailLabel string 'Email' Name emailLabel Description Shown as the email field's label.
Type string Default 'Email' emailHelp string 'We send your order confirmation and shipping updates here.' Name emailHelp Description Shown in the tooltip beside the email field.
Type string Default 'We send your order confirmation and shipping updates here.' newsletterLabel string 'Email me with news and offers' Name newsletterLabel Description Shown beside the newsletter checkbox.
Type string Default 'Email me with news and offers' deliveryTitle string 'Delivery' Name deliveryTitle Description Shown as the delivery card's heading.
Type string Default 'Delivery' deliveryDescription string 'Where should we send your order?' Name deliveryDescription Description Shown under the delivery card's heading; hidden when empty.
Type string Default 'Where should we send your order?' countryLabel string 'Country/Region' Name countryLabel Description Shown as the country select's label.
Type string Default 'Country/Region' firstNameLabel string 'First name' Name firstNameLabel Description Shown as the first-name field's label.
Type string Default 'First name' lastNameLabel string 'Last name' Name lastNameLabel Description Shown as the last-name field's label.
Type string Default 'Last name' streetLabel string 'Street' Name streetLabel Description Shown as the address field's label while the building number has a field of its own.
Type string Default 'Street' addressLabel string 'Address' Name addressLabel Description Shown as the address field's label while it holds the building number too.
Type string Default 'Address' houseNumberLabel string 'Building number' Name houseNumberLabel Description Shown as the building number field's label.
Type string Default 'Building number' apartmentLabel string 'Apartment, suite, etc. (optional)' Name apartmentLabel Description Shown as the label of the optional second address line.
Type string Default 'Apartment, suite, etc. (optional)' zipLabel string 'Postal code' Name zipLabel Description Shown as the postal code field's label.
Type string Default 'Postal code' cityLabel string 'City' Name cityLabel Description Shown as the city field's label.
Type string Default 'City' phoneLabel string 'Phone' Name phoneLabel Description Shown as the phone field's label.
Type string Default 'Phone' phoneHelp string 'In case we need to reach you about your order.' Name phoneHelp Description Shown in the tooltip beside the phone field.
Type string Default 'In case we need to reach you about your order.' phoneNote string 'Please use your mobile phone number.' Name phoneNote Description Shown under the phone field; hidden when empty.
Type string Default 'Please use your mobile phone number.' shippingTitle string 'Shipping method' Name shippingTitle Description Shown as the shipping method section's heading.
Type string Default 'Shipping method' shippingPending string 'Enter your shipping address to view available shipping methods.' Name shippingPending Description Shown in place of the shipping methods until the address is complete.
Type string Default 'Enter your shipping address to view available shipping methods.' freeLabel string 'Free' Name freeLabel Description Shown in place of a shipping price of zero.
Type string Default 'Free' paymentTitle string 'Payment' Name paymentTitle Description Shown as the payment section's heading.
Type string Default 'Payment' paymentDescription string 'All transactions are secure and encrypted.' Name paymentDescription Description Shown under the payment heading; hidden when empty.
Type string Default 'All transactions are secure and encrypted.' cardBrands PaymentCardBrand[] [ 'visa' , 'mastercard' , 'amex' ] Name cardBrands Description The card brands whose marks show in the number field, such as the ones the shop accepts.
Type PaymentCardBrand[] Default [ 'visa' , 'mastercard' , 'amex' ] cardNumberLabel string 'Card number' Name cardNumberLabel Description Shown as the card number field's label.
Type string Default 'Card number' expiryLabel string 'Expiration date' Name expiryLabel Description Shown as the card expiry field's label.
Type string Default 'Expiration date' cvcLabel string 'Security code' Name cvcLabel Description Shown as the card security code field's label.
Type string Default 'Security code' cvcHelp string 'The 3 or 4 digits on the back of your card.' Name cvcHelp Description Shown in the tooltip beside the security code field.
Type string Default 'The 3 or 4 digits on the back of your card.' cardNameLabel string 'Name on card' Name cardNameLabel Description Shown as the cardholder name field's label.
Type string Default 'Name on card' billingSameLabel string 'Use shipping address as billing address' Name billingSameLabel Description Shown beside the checkbox that bills the shipping address; unticking it reveals the billing address.
Type string Default 'Use shipping address as billing address' billingTitle string 'Billing address' Name billingTitle Description Shown as the billing address's heading.
Type string Default 'Billing address' rememberLabel string 'Save my details for a faster checkout' Name rememberLabel Description Shown beside the checkbox that saves the shopper's details.
Type string Default 'Save my details for a faster checkout' rememberPhoneLabel string 'Mobile phone (optional)' Name rememberPhoneLabel Description Shown as the label of the phone field the remember checkbox reveals.
Type string Default 'Mobile phone (optional)' rememberNote string 'Next time we text you a code and fill in the rest.' Name rememberNote Description Shown under the remember checkbox's label, e.g. what saving the details means; hidden when empty.
Type string Default 'Next time we text you a code and fill in the rest.' payLabel string 'Pay now' Name payLabel Description Shown on the button that submits the order.
Type string Default 'Pay now' summaryLabel string 'Order summary' Name summaryLabel Description Shown as the summary card's heading and on the bar that folds it out on narrow screens.
Type string Default 'Order summary' discountLabel string 'Discount code or gift card' Name discountLabel Description Shown as the discount field's label.
Type string Default 'Discount code or gift card' discountPlaceholder string 'Enter a code' Name discountPlaceholder Description Shown in the empty discount field.
Type string Default 'Enter a code' discountHint string — Name discountHint Description Shown under the discount field, e.g. which codes can be combined.
Type string Default — applyLabel string 'Apply' Name applyLabel Description Shown on the button that applies the discount code.
Type string Default 'Apply' addDiscountLabel string 'Add discount' Name addDiscountLabel Description Shown on the button that reveals the discount field at the foot of the form on narrow screens.
Type string Default 'Add discount' removeDiscountLabel ( ( label : string ) => string ) `Remove ${ label } ` Name removeDiscountLabel Description Builds the screen-reader name of the button that removes an applied code from its row label.
Type ( label : string ) : string Default `Remove ${ label } ` subtotalLabel string 'Subtotal' Name subtotalLabel Description Shown next to the subtotal.
Type string Default 'Subtotal' shippingLabel string 'Shipping' Name shippingLabel Description Shown next to the shipping cost.
Type string Default 'Shipping' shippingUnknown string 'Enter shipping address' Name shippingUnknown Description Shown in place of the shipping cost until a method is chosen.
Type string Default 'Enter shipping address' minusSign string MINUS_SIGN Name minusSign Description Put before each amount an applied code takes off.
Type string Default MINUS_SIGN totalLabel string 'Total' Name totalLabel Description Shown next to the order total.
Type string Default 'Total' itemCountLabel ( ( count : number ) => string ) count === 1 ? '1 item' : ` ${ count } items` Name itemCountLabel Description Builds the item count beside the summary's heading and under the total at the foot of the form on narrow screens.
Type ( count : number ) : string Default count === 1 ? '1 item' : ` ${ count } items` taxNote ( ( tax : string ) => string ) `Including ${ tax } in taxes` Name taxNote Description Builds the note under the total from the included tax, already formatted.
Type ( tax : string ) : string Default `Including ${ tax } in taxes` quantityLabel ( ( quantity : number ) => string ) `Qty: ${ quantity } ` Name quantityLabel Description Builds each line's quantity text in the summary, e.g. Qty: 2 .
Type ( quantity : number ) : string Default `Qty: ${ quantity } ` class ClassValue — Name class Description Classes added to the part's own element, after its recipe classes.
Type null | string | false | Record < string , any > | ClassValue[] Default —