Package
object
The package object represents a package, which is a collection of items that can be purchased together.
Attributes
package.id
string
The unique id of the package.
package.name
string
The name of the package.
package.tagline
string
The tagline of the package.
package.type
string
Will always return “package”.
package.price_fractional
number
The total price for the package represented in the sub-unit of the current customer’s currency. e.g. considering the amount $19.50, it will return 1950.
package.requires_date
boolean
Whether the package requires a date to be selected when adding to the cart. A date field with the name package[start_date] will be required when adding the package to the cart, optionally with a package[start_time] field matching the format HH:MM can be added to the form.
package.price_per_person_fractional
number
The price per person for the package represented in the sub-unit of the current customer’s currency. e.g. considering the amount $19.50, it will return 1950.
package.image
The package’s image.
package.items
The included items in the package.
package.off_sale
boolean
Whether the package is off sale.
package.off_sale_copy
string
The copy to display when the package is off sale.
package.payment_plan
If the package is custom priced and has a payment plan associated with it, this will return that payment plan. The payment plan won’t be returned if the instalment schedule cannot be completed before the start date of the package.
package.state
string
The state of the package. Can be one of:
- draft
- selling
- off_sale
package.steps
The booking journey steps available for a package.
package.booking_fee_rate
number
The package’s booking fee rate as a decimal between 0 and 1.
package.total_booking_fee
number
The package’s total booking fee represented in the sub-unit of the current customer’s currency. e.g. considering the amount $19.50, it will return 1950.