Link Search Menu Expand Document

Cart

object

Attributes

cart.items

array of Cart items

An array of cart items associated with the cart.

cart.currency

string

The currency code associated with the cart.

cart.custom_data

object

An object containing any custom data properties associated with the cart

cart.subtotal

number

The amount of the cart before any price reductions have been applied. This is returned as a fractional in the sub-unit of the current customer’s currency.

cart.total

number

The amount of the cart after all price reductions have been applied. This is returned as a fractional in the sub-unit of the current customer’s currency.

cart.total_fee

number

The booking fee amount returned as a fractional in the sub-unit of the current customer’s currency.

cart.total_price_reduction

number

The total amount of all price reductions from promotions or vouchers. This is returned as a fractional in the sub-unit of the current customer’s currency.

cart.total_deposit

number

The minimum payment possible at checkout if choosing to pay with a deposit. This will be zero if a deposit is not enabled for any of the products in the cart. This is returned as a fractional in the sub-unit of the current customer’s currency.

cart.start_on

timestamp

The earliest start on from all the cart’s line items. Returns nil if the cart doesn’t have any line items.

cart.end_on

timestamp

The latest end on from all the cart’s line items. Returns nil if the cart doesn’t have any line items.

cart.first_instalment_amount

number

The amount due for the cart on a payment plan. Returns zero if no payment plan is enabled. This is returned as a fractional in the sub-unit of the current customer’s currency.


Table of contents