Fee item rate

A fee applied to a variant. Returned as items in variant.fees.

Properties

applies

How this fee applies based on guest and duration strategies.

Returns: String — e.g. "Per person, per night" or "Per item, per stay".

description

A human-readable description of the fee amount.

Returns: String or nil — a percentage string (e.g. "2.5%") or a formatted money string in the current currency (e.g. "£77.50"). Uses the creator's home currency when no current currency is set.

fee_name

The name of the fee, e.g. "Cleaning fee" or "Booking fee".

Returns: String

id

The fee item rate's unique identifier.

Returns: String — a UUID.

off_platform

Whether this fee is collected off the Easol platform, for example, when a guest checks into the accommodation.

Returns: Boolean