Tax item rate

A tax applied to a variant. Returned as items in variant.taxes.

Properties

applies

How this tax 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 tax 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.

id

The tax item rate's unique identifier.

Returns: String — a UUID.

off_platform

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

Returns: Boolean

tax_name

The name of the tax, e.g. "VAT" or "New York State Tax".

Returns: String