checkout

Properties

Anchor to

applied_gift_cards

array of gift_card

The gift cards applied to the checkout.

Anchor to

attributes

Additional attributes entered by the customer with the cart.

Shopify Plus merchants that have access to checkout.liquid can capture attributes at checkout.

Anchor to

billing_address

address

The billing address entered at checkout.

Anchor to

buyer_accepts_marketing

boolean

Returns true if the customer checks the email marketing subscription checkbox. Returns false if not.

Anchor to

cart_level_discount_applications

array of discount_application

The cart-specific discount applications for the checkout.

Anchor to

currency

string

The ISO code of the currency of the checkout.

Anchor to

customer

customer

The customer associated with the checkout.

Note

The customer object is directly accessible globally when a customer is logged in to their account.

Anchor to

discount_applications

array of discount_application

The discount applications for the checkout.

Anchor to

discounts_amount

array of discount_application

The total amount of the discounts applied to the checkout in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

discounts_savings

array of discount_application

The total amount of the discounts applied to the checkout in the currency's subunit, as a negative value.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

email

string

The email associated with the checkout.

Anchor to

gift_cards_amount

number

The amount of the checkout price paid in gift cards.

The value is output in the customer's local (presentment) currency.

Tip

Use money filters to output a formatted amount.

Anchor to

id

number

The ID of the checkout.

Anchor to

item_count

number

The number of items in the checkout.

Anchor to

line_items

array of line_item

The line items of the checkout.

Anchor to

line_items_subtotal_price

number

The sum of the prices of all of the line items of the checkout in the currency's subunit, after any line item discounts. have been applied.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

name

number

The name of the checkout.

This value is the same as checkout.id with a # prepended to it.

Anchor to

note

string

Additional information entered by the customer with the cart.

Anchor to

order

order

The order created by the checkout.

Depending on the payment provider, the order might not have been created when the Thank you page is first viewed. In this case, nil is returned.

Note

The order object isn't available on the Thank you page.

Anchor to

order_id

string

The ID of the order created by the checkout.

The value is the same as order.id.

Depending on the payment provider, the order might not have been created when the Order status page is first viewed. In this case, nil is returned.

Anchor to

order_name

string

The name of the order created by the checkout.

The value is the same as order.name.

Depending on the payment provider, the order might not have been created when the Order status page is first viewed. In this case, nil is returned.

Anchor to

order_number

string

An integer representation of the name of the order created by the checkout.

The value is the same as order.order_number.

Depending on the payment provider, the order might not have been created when the Order status page is first viewed. In this case, nil is returned.

Anchor to

requires_shipping

boolean

Returns true if any of the line items of the checkout require shipping. Returns false if not.

Anchor to

shipping_address

address

The shipping address of the checkout.

Anchor to

shipping_method

shipping_method

The shipping method of the checkout.

Anchor to

shipping_price

number

The shipping price of the checkout in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

tax_lines

array of tax_line

The tax lines for the checkout.

Anchor to

tax_price

number

The total tax amount of the checkout in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

total_price

number

The total price of the checkout in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.

Anchor to

transactions

array of transaction

The transactions of the checkout.