Deposit

object

Attributes

deposit.enabled

boolean

Returns true if this variant, extra or package can be paid with a deposit.

deposit.rate

number

The deposit rate as a value between 0 and 1. For example, if the deposit is 50% this will return 0.5. If the variant has an active promotion the deposit rate should be applied to the promotional price.

Example

{% assign promotional_price = variant.price | apply_promotion: variant.promotion %}
{% assign deposit_price = promotional_price.fractional | times: variant.deposit.rate %}
{{ deposit_price | money }}

deposit.due_date

Date

The date the final balance payment will be due, if this can be calculate and the deposit is enabled. This can be formatted with Liquid’s date filters. The Creator may have set this as a number of days relative to the experience or accommodation start date, or they may have selected a specific date from a calendar. They also may have not set a value, in which case a default of 60 days before start date is used.

• When accessed through an experience slot it will return a date.
• When accessed through a single slot experience it will return a date.
• When accessed through a fixed-date package it will return a date.
• When accessed through a multislot experience, an accommodation, or a multi-date package, it will return nil.

Example

{{ deposit.due_date | date: "%Y-%m-%d" }}
{% endif %}

deposit.due_date_threshold

number

The number of days before the start date when the final balance payment will be due. If the creator has not set a value, the platform default of 7 is returned.

This value is used when calculating deposit.due_date and deposit.enabled. When deposit.due_date is nil, you can use this value to explain the advance booking requirement. A customer must book at least deposit.due_date_threshold | plus: 1 days before the start date to pay by deposit.

Example

{% assign deposit_advance_days = deposit.due_date_threshold | plus: 1 %}

{% if deposit.due_date %}
  Pay the rest on or before {{ deposit.due_date | date: "%d %B %Y" }}.
{% else %}
  Pay the rest before your experience starts. You must book at least {{ deposit_advance_days }} days in advance to pay by deposit.
{% endif %}