> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Checkout

GraphQL object

The checkout.

Reference: https://docs.bigcommerce.com/developer/api-reference/graphql/storefront/types/objects/checkout

## Fields

- `id` — The ID of an object
- `entityId` — Checkout ID.
- `currencyCode` — ISO-4217 currency code of the checkout.
- `displayCurrencyCode` — ISO-4217 currency code. Applied DisplayCurrencyCode for the checkout.
- `billingAddress` — Billing address information.
- `cart` — Cart associated with the checkout.
- `shippingConsignments` — List of shipping consignments.
- `shippingCostTotal` — Total shipping cost before any discounts are applied.
- `shippingCostTotalInDisplayCurrency` — Total shipping cost in display currency.
- `shippingCostBeforeDiscount` — Total shipping cost before any discounts are applied.
- `shippingCostBeforeDiscountInDisplayCurrency` — Shipping cost before discount in display currency.
- `comparisonShippingCost` — The total shipping cost before coupon discounts are applied.
- `comparisonShippingCostInDisplayCurrency` — Comparison shipping cost in display currency.
- `giftWrappingCostTotal` — Gift wrapping cost for all items, including or excluding tax.
- `giftWrappingCostTotalInDisplayCurrency` — Gift wrapping cost in display currency.
- `handlingCostTotal` — Handling cost for all consignments including or excluding tax.
- `handlingCostTotalInDisplayCurrency` — Handling cost in display currency.
- `taxTotal` — Total amount of taxes applied.
- `taxTotalInDisplayCurrency` — Total amount of taxes in display currency.
- `taxes` — List of taxes applied.
- `subtotal` — Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.
- `subtotalInDisplayCurrency` — Subtotal in display currency.
- `grandTotal` — The total payable amount, before applying any store credit or gift certificate.
- `grandTotalInDisplayCurrency` — Grand total in display currency.
- `createdAt` — Time when the checkout was created.
- `updatedAt` — Time when the checkout was last updated.
- `customerMessage` — Shopper's message provided as details for the order to be created from the checkout.
- `outstandingBalance` — GrandTotal subtract the store-credit amount.
- `outstandingBalanceInDisplayCurrency` — Outstanding balance in display currency.
- `coupons` — Coupons applied at checkout level.
- `giftCertificates` — Gift Certificates applied at checkout level.
- `promotions` — List of promotions
- `fees` — List of fees applied.
- `version` — The current version of the checkout, which is updated with every change.
- `totalDiscount` — Total discount amount applied to the checkout.
- `totalDiscountInDisplayCurrency` — Total discount amount in display currency.
- `displayDiscountTotal` — Display discount total amount excluding product-level auto promotion discounts and shipping auto promotion discounts.
- `displayDiscountTotalInDisplayCurrency` — Display discount total amount in display currency.
- `orderBasedAutoDiscountTotal` — Order-based automatic discount total amount.
- `orderBasedAutoDiscountTotalInDisplayCurrency` — Order-based automatic discount total amount in display currency.
- `manualDiscountTotal` — Manual discount total amount.
- `manualDiscountTotalInDisplayCurrency` — Manual discount total amount in display currency.
- `order` — Order associated with the checkout.

## Definition

```graphql
type Checkout implements Node {
  id: String!
  entityId: String!
  currencyCode: String!
  displayCurrencyCode: String!
  billingAddress: CheckoutBillingAddress
  cart: Cart
  shippingConsignments: [CheckoutShippingConsignment!]
  shippingCostTotal: Money
  shippingCostTotalInDisplayCurrency: Money
  shippingCostBeforeDiscount: Money!
  shippingCostBeforeDiscountInDisplayCurrency: Money!
  comparisonShippingCost: Money!
  comparisonShippingCostInDisplayCurrency: Money!
  giftWrappingCostTotal: Money
  giftWrappingCostTotalInDisplayCurrency: Money
  handlingCostTotal: Money
  handlingCostTotalInDisplayCurrency: Money
  taxTotal: Money
  taxTotalInDisplayCurrency: Money
  taxes: [CheckoutTax!]
  subtotal: Money
  subtotalInDisplayCurrency: Money
  grandTotal: Money
  grandTotalInDisplayCurrency: Money
  createdAt: DateTimeExtended!
  updatedAt: DateTimeExtended!
  customerMessage: String
  outstandingBalance: Money
  outstandingBalanceInDisplayCurrency: Money
  coupons: [CheckoutCoupon!]!
  giftCertificates: [CheckoutGiftCertificate!]!
  promotions: [CheckoutPromotion!]!
  fees: [CheckoutFee!]!
  version: Int
  totalDiscount: Money!
  totalDiscountInDisplayCurrency: Money!
  displayDiscountTotal: Money!
  displayDiscountTotalInDisplayCurrency: Money!
  orderBasedAutoDiscountTotal: Money!
  orderBasedAutoDiscountTotalInDisplayCurrency: Money!
  manualDiscountTotal: Money!
  manualDiscountTotalInDisplayCurrency: Money!
  order: Order
}
```