A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).
Access Scopes
Fields
appliedGiftCards:
AppliedGiftCard! -
The gift cards used on the checkout.
availableShippingRates:
AvailableShippingRates -
The available shipping rates for this Checkout.
Should only be used when checkout `requiresShipping` is `true` and
the shipping address is valid.
createdAt:
DateTime! -
The date and time when the checkout was created.
currencyCode:
CurrencyCode! -
The currency code for the checkout.
customAttributes:
Attribute! -
The extra information added to the checkout.
email:
String -
The email associated with this checkout.
lineItemsSubtotalPrice:
MoneyV2! -
The sum of all the prices of all the items in the checkout,
excluding duties, taxes, shipping, and discounts.
note:
String -
The note associated with the checkout.
paymentDue:
MoneyV2! -
The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards.
ready:
Boolean! -
Whether the Checkout is ready and can be completed. Checkouts may
have asynchronous operations that can take time to finish. If you want
to complete a checkout or ensure all the fields are populated and up to
date, polling is required until the value is true.
requiresShipping:
Boolean! -
Whether the fulfillment requires shipping.
shippingDiscountAllocations:
DiscountAllocation! -
The discounts allocated to the shipping line by discount applications.
shippingLine:
ShippingRate -
The selected shipping rate, transitioned to a `shipping_line` object.
subtotalPrice:
MoneyV2! -
The price at checkout before duties, shipping, and taxes.
taxExempt:
Boolean! -
Whether the checkout is tax exempt.
taxesIncluded:
Boolean! -
Whether taxes are included in the line item and shipping line prices.
totalDuties:
MoneyV2 -
The sum of all the duties applied to the line items in the checkout.
totalPrice:
MoneyV2! -
The sum of all the prices of all the items in the checkout,
duties, taxes, and discounts included.
totalTax:
MoneyV2! -
The sum of all the taxes applied to the line items and shipping lines in the checkout.
webUrl:
URL! -
The URL for the checkout, accessible from the web.