Cart item package booking

A transparently priced package booking shown as a single cart line.

A transparently priced package booking shown as a single cart line. Available when the package displays its total price, or its total price with element prices. Access via cart.items alongside CartItemDrop entries. Exposes the same interface as CartItemDrop so cart templates can treat both interchangeably.

Properties

adult_count

The number of guests on the package booking.

Returns: Integer or nil

end_on

Latest end date across the package booking's line items.

Returns: Date or nil

end_time

Not applicable to grouped package bookings.

Returns: nil

experience_slot

Not applicable to grouped package bookings.

Returns: nil

id

The package booking's unique identifier.

Returns: String — a UUID.

in_custom_priced_package

Grouped transparent packages are not custom-priced package bookings.

Returns: Boolean — always false.

package_booking

The package booking this cart line represents.

Returns: PackageBookingDrop

price

Package price from current line items only, in the subunit of the current currency. Does not estimate prices for incomplete required steps.

Returns: Integer

product

Not applicable to grouped package bookings.

Returns: nil

quantity

Always 1 — the grouped package is a single cart line.

Returns: Integer

removable?

Grouped package bookings can always be removed from the cart.

Returns: Boolean — always true.

selections

Grouped package bookings have no modifier selections at the package level.

Returns: Array — always empty.

show_price?

Whether to show the package's price. False when the package shows each element's price instead.

Returns: Boolean

{% if item.show_price? %}{{ item.price | money }}{% endif %}
{% for sub_item in item.sub_items %}
  {{ sub_item.variant_name }}
  {% if sub_item.show_price? %}{{ sub_item.price | money }}{% endif %}
{% endfor %}

start_on

Earliest start date across the package booking's line items.

Returns: Date or nil

start_time

Not applicable to grouped package bookings.

Returns: nil

sub_items

Line items included in this package booking.

Returns: Array (CartItemDrop)

subtotal

Package price from current line items only, in the subunit of the current currency. Does not estimate prices for incomplete required steps.

Returns: Integer

total

Package total after fees and price reductions, in the subunit of the current currency.

Returns: Integer

total_deposit

Not calculated at the grouped package level.

Returns: Integer — always 0.

total_fee

Total on-platform booking fees for the package booking's line items, in the subunit of the current currency. Includes the payment plan fee only once the customer has chosen to pay with a payment plan at checkout.

Returns: Integer

total_guests

The package booking's guest count.

Returns: Integer or nil

total_modifications_amount

Not calculated at the grouped package level.

Returns: Integer — always 0.

total_off_platform_fee

Total off-platform booking fees for the package booking's line items, in the subunit of the current currency.

Returns: Integer

total_package_upgrade_amount

Not calculated at the grouped package level.

Returns: Integer — always 0.

unit_subtotal

Same as CartItemPackageBookingDrop#subtotal because quantity is always 1.

Returns: Integer

variant

Not applicable to grouped package bookings.

Returns: nil

variant_name

The package's display name.

Returns: String

On this page