The checkout object
The checkout object can be accessed in the order status page of the checkout. Shopify Plus merchants can also access properties of the checkout object in the checkout.liquid layout file.
The checkout object has the following attributes:
checkout.applied_gift_cards
Anchor link to section titled "checkout.applied_gift_cards"Returns the gift cards applied to the checkout.
checkout.attributes
Anchor link to section titled "checkout.attributes"Returns the attributes of the checkout, that were captured in the cart.
checkout.billing_address
Anchor link to section titled "checkout.billing_address"Returns the billing address of the checkout.
checkout.buyer_accepts_marketing
Anchor link to section titled "checkout.buyer_accepts_marketing"Returns whether the buyer accepted the newsletter during the checkout.
checkout.cart_level_discount_applications
Anchor link to section titled "checkout.cart_level_discount_applications"Returns an array of any cart-specific discount applications for the checkout.
checkout.currency
Anchor link to section titled "checkout.currency"Returns the ISO code of the checkout currency.
checkout.customer
Anchor link to section titled "checkout.customer"Returns the customer associated with the checkout.
checkout.discount_applications
Anchor link to section titled "checkout.discount_applications"Returns an array of discount applications for a checkout.
checkout.discounts_amount
Anchor link to section titled "checkout.discounts_amount"Returns the sum of the amount of the discounts applied to the checkout.
checkout.discounts_savings
Anchor link to section titled "checkout.discounts_savings"Returns the sum of the savings of the discounts applied to the checkout. The negative opposite of discounts_amount.
checkout.email
Anchor link to section titled "checkout.email"Returns the email used during the checkout.
checkout.gift_cards_amount
Anchor link to section titled "checkout.gift_cards_amount"Returns the amount paid in gift cards of the checkout.
checkout.id
Anchor link to section titled "checkout.id"Returns the id of the checkout.
checkout.line_items
Anchor link to section titled "checkout.line_items"Returns all the line items of the checkout.
checkout.line_items_subtotal_price
Anchor link to section titled "checkout.line_items_subtotal_price"Returns the sum of the cart's line item prices after any line item discounts. The subtotal doesn't include taxes (unless taxes are included in the prices), cart discounts, or shipping costs.
checkout.name
Anchor link to section titled "checkout.name"Returns the name of the checkout. This value is identical to checkout.id with a hash prepended to it.
checkout.note
Anchor link to section titled "checkout.note"Returns the note of the checkout.
checkout.order
Anchor link to section titled "checkout.order"Returns the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page and this property could be nil.
checkout.order_id
Anchor link to section titled "checkout.order_id"Returns the id of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.order_name
Anchor link to section titled "checkout.order_name"Returns the name of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.order_number
Anchor link to section titled "checkout.order_number"Returns the number of the order created by the checkout. Depending on the payment provider, the order might not have been created yet on the checkout order status page.
checkout.requires_shipping
Anchor link to section titled "checkout.requires_shipping"Returns whether the checkout as a whole requires shipping, that is whether any of the line items require shipping.
checkout.shipping_address
Anchor link to section titled "checkout.shipping_address"Returns the shipping address of the checkout.
checkout.shipping_method
Anchor link to section titled "checkout.shipping_method"Returns the shipping method of the checkout.
checkout.shipping_methods
Anchor link to section titled "checkout.shipping_methods"Returns an array of shipping methods of the checkout.
checkout.shipping_price
Anchor link to section titled "checkout.shipping_price"Returns the shipping price of the checkout.
checkout.tax_lines
Anchor link to section titled "checkout.tax_lines"Returns all the tax lines of the checkout.
checkout.tax_price
Anchor link to section titled "checkout.tax_price"Returns the tax price of the checkout, whether the taxes are included or not in the prices.
checkout.total_price
Anchor link to section titled "checkout.total_price"Returns the total price of the checkout.
checkout.transactions
Anchor link to section titled "checkout.transactions"Returns an array of transactions from the checkout.