Cart item
object
Attributes
item.adult_count
number
The number of guests selected for the variant.
item.end_on
timestamp
The end date of the product associated with the cart item.
item.start_time
timestamp
The start time of the cart item, if present, as a string in the form of a 24 hour clock, e.g. “11:00”
item.end_time
timestamp
The end time of the cart item, if present, as a string in the form of a 24 hour clock, e.g. “11:00” Note: This considers custom durations and should be used instead of the experience slot’s end time.
item.experience_slot
The Experience Slot for the cart item, if the cart item product is an Experience-type.
item.id
string
A unique ID for the cart item.
item.in_custom_priced_package
boolean
Whether the item is part of a custom priced package.
item.quantity
number
The quantity selected on the cart item.
item.price
number
The price of the cart item not including any modifier selections and not including any price reductions. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.product
The product associated with the cart item.
item.removable?
boolean
Whether the item is eligible for removal from the cart or not. Please note: items included in a package can only be removed while the customer is on the corresponding package step.
item.selections
array of Modifier selections
The modifier selections made on the cart item.
item.start_on
timestamp
The start date of the product associated with the cart item.
item.sub_items
array of Cart items
The related sub-items for a Cart item. Currently these are available for cart items that are for a custom-priced package, and the sub-items are all other line items that are part of its package booking.
item.subtotal
number
The price of the cart item, including the total price of all modifier selections and not including any price reductions. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.total
number
The total cost of the item, including the total price of all modifier selections and after all price reductions and fees have been applied. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.total_deposit
number
The minimum amount to be paid for the item at checkout. If no deposit is enabled this will return the total, otherwise it will return the total multiplied by the deposit rate. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.total_fee
number
The booking fee amount for the item returned as a fractional in the sub-unit of the current customer’s currency. Does not include off-platform fees.
item.total_off_platform_fee
number
The off-platform booking fee amount for the item returned as a fractional in the sub-unit of the current customer’s currency.
item.total_guests
number
The total number of guests on the cart item, i.e. quantity multiplied by adult_count.
item.total_modifications_amount
number
The total of all the modifier selections made on the cart item. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.total_package_upgrade_amount
number
The total of all the package upgrades associated with the cart item. This is returned as a fractional in the sub-unit of the current customer’s currency.
item.variant
The variant associated with the cart item.
item.variant_name
string
The name of the variant associated with the cart item.
item.package_booking
The associated package booking if the item is being booked as part of a package.
It will return nil if the item isn’t part of a package.