Deposit

The deposit payment option for a product, variant, or experience slot. Available on product.deposit, variant.deposit, and slot.deposit.

Properties

due_date

The date the final balance payment is due.

Returns: Date or nil — nil when deposits are disabled; the due date cannot be calculated (accommodations, multi-slot experiences without a date, or multi-date packages); or there is insufficient time between the start date and the due date to make a deposit.

due_date_threshold

The number of days before the experience or accommodation start date when the final balance payment is due.

Returns: Integer — the creator-configured threshold, or 7 when unset.

enabled

Whether the customer can pay by deposit for this product and start date.

Returns: Boolean — false when deposits are disabled, or when the balance due date would fall on or before today. For accommodations and multi-date packages, only checks whether deposits are enabled on the product.

rate

The deposit rate as a decimal between 0 and 1, e.g. 0.5 for 50%. Apply to the promotional price when a promotion is active.

Returns: Float