v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB

Discounts

Create a new discount.

post/v2/discounts

Request body

idinteger

The ID of this record.

activeboolean

Indicates whether this surcharge is active.

amountnumber

The base amount of the surcharge. Always a positive value.

amount_multiplier'per_night' | 'per_stay' | 'per_increment' | 'per_night_and_increment'

auto_generate_descriptionboolean

Indicates whether the description should be auto-generated.

category'additional_bed' | 'administrative' | 'air_conditioning' | 'arrival_early' | 'arrival_late' | 'association_property' | 'baby_bed' | 'booking' | 'booking_early' | 'booking_late' | 'city_tax' | 'class' | 'cleaning' | 'club' | 'concierge' | 'consumption' | 'daily_cleaning' | 'departure_early' | 'departure_late' | 'deposit_damage' | 'electricity' | 'energy' | 'equipment' | 'final_cleaning' | 'food' | 'gardening' | 'gas' | 'guest' | 'heating' | 'high_chair' | 'hot_tub' | 'internet' | 'labor' | 'laundry' | 'linens' | 'linens_bath' | 'linens_bed' | 'management' | 'oil' | 'on_site_payment_method' | 'parking' | 'pet' | 'phone' | 'pool' | 'pool_heating' | 'property_fee' | 'rent' | 'reservation' | 'resort' | 'service' | 'spa' | 'tax' | 'toiletries' | 'tour' | 'tourist_tax' | 'transportation' | 'utensils_cleaning' | 'utensils_food' | 'vehicle' | 'waiver_damage' | 'water' | 'water_craft' | 'water_craft_mooring' | 'water_drinking' | 'wood' | 'discount' | 'cancellation_fee' | 'other'

created_utcstring date-time

The date and time this record was created (UTC).

descriptionstring

The description of the surcharge (maximum 256 characters).

expense_amountnumber

The expense amount (minimum 0).

expense_category_idinteger nullable

The ID of the expense category.

expense_date_type'arrival_date' | 'departure_date' | 'booked_date' | 'canceled_date' | 'transaction_date'

expense_descriptionstring

The description of the expense.

expense_vendor_contact_idinteger nullable

The ID of the expense vendor contact.

explanationstring

Additional explanation text displayed to guests.

is_applicable_to_rent_onlyboolean

Indicates whether this surcharge is applicable to rent only (when IsPercent is true).

is_expense_pre_deduct_pmboolean

Indicates whether the expense should be pre-deducted from the property manager.

is_percentboolean

Indicates whether the amount is a percentage of rent.

is_taxableboolean

Indicates whether this surcharge is taxable.

listing_site_idsinteger[]

Listing site IDs this surcharge applies to. Used with listing_site_scope.

listing_site_scope'exclude' | 'include' | 'all'

mode'automatic' | 'optional' | 'manual' | 'code' | 'offline'

place_under_taxboolean

Indicates whether this surcharge should be placed under tax line items. Cannot be true if IsTaxable is true.

positioninteger nullable

The display position/order of the surcharge (minimum 0).

property_idsinteger[]

Property IDs this surcharge applies to. Used with property_scope.

property_scope'exclude' | 'include' | 'all'

season_idsinteger[]

Season IDs this surcharge applies to. Used with season_scope.

season_scope'exclude' | 'include' | 'all'

show_as_rentboolean

Indicates whether this surcharge should be shown as rent.

type'complex' | 'rate_adjustment' | 'guest_fee' | 'pet_fee' | 'cleaning_fee' | 'linen_fee' | 'other_fee' | 'length_of_stay_discount' | 'last_minute_discount' | 'early_bird_discount' | 'audience_promotion' | 'member_promotion' | 'new_listing_discount' | 'high_rated_guest_discount'

updated_utcstring date-time nullable

The date and time this record was last updated (UTC).

discount_codestring

The discount code for code-based discounts (maximum 64 characters). Required when Mode is Code.

is_discount_code_exclusiveboolean

Indicates whether this discount code should remove all other discounts when applied.

Response

A model representing the discount created.

idinteger

The ID of this record.

activeboolean

Indicates whether this surcharge is active.

amountnumber

The base amount of the surcharge. Always a positive value.

amount_multiplier'per_night' | 'per_stay' | 'per_increment' | 'per_night_and_increment'

auto_generate_descriptionboolean

Indicates whether the description should be auto-generated.

category'additional_bed' | 'administrative' | 'air_conditioning' | 'arrival_early' | 'arrival_late' | 'association_property' | 'baby_bed' | 'booking' | 'booking_early' | 'booking_late' | 'city_tax' | 'class' | 'cleaning' | 'club' | 'concierge' | 'consumption' | 'daily_cleaning' | 'departure_early' | 'departure_late' | 'deposit_damage' | 'electricity' | 'energy' | 'equipment' | 'final_cleaning' | 'food' | 'gardening' | 'gas' | 'guest' | 'heating' | 'high_chair' | 'hot_tub' | 'internet' | 'labor' | 'laundry' | 'linens' | 'linens_bath' | 'linens_bed' | 'management' | 'oil' | 'on_site_payment_method' | 'parking' | 'pet' | 'phone' | 'pool' | 'pool_heating' | 'property_fee' | 'rent' | 'reservation' | 'resort' | 'service' | 'spa' | 'tax' | 'toiletries' | 'tour' | 'tourist_tax' | 'transportation' | 'utensils_cleaning' | 'utensils_food' | 'vehicle' | 'waiver_damage' | 'water' | 'water_craft' | 'water_craft_mooring' | 'water_drinking' | 'wood' | 'discount' | 'cancellation_fee' | 'other'

created_utcstring date-time

The date and time this record was created (UTC).

descriptionstring

The description of the surcharge (maximum 256 characters).

expense_amountnumber

The expense amount (minimum 0).

expense_category_idinteger nullable

The ID of the expense category.

expense_date_type'arrival_date' | 'departure_date' | 'booked_date' | 'canceled_date' | 'transaction_date'

expense_descriptionstring

The description of the expense.

expense_vendor_contact_idinteger nullable

The ID of the expense vendor contact.

explanationstring

Additional explanation text displayed to guests.

is_applicable_to_rent_onlyboolean

Indicates whether this surcharge is applicable to rent only (when IsPercent is true).

is_expense_pre_deduct_pmboolean

Indicates whether the expense should be pre-deducted from the property manager.

is_percentboolean

Indicates whether the amount is a percentage of rent.

is_taxableboolean

Indicates whether this surcharge is taxable.

listing_site_idsinteger[]

Listing site IDs this surcharge applies to. Used with listing_site_scope.

listing_site_scope'exclude' | 'include' | 'all'

mode'automatic' | 'optional' | 'manual' | 'code' | 'offline'

place_under_taxboolean

Indicates whether this surcharge should be placed under tax line items. Cannot be true if IsTaxable is true.

positioninteger nullable

The display position/order of the surcharge (minimum 0).

property_idsinteger[]

Property IDs this surcharge applies to. Used with property_scope.

property_scope'exclude' | 'include' | 'all'

season_idsinteger[]

Season IDs this surcharge applies to. Used with season_scope.

season_scope'exclude' | 'include' | 'all'

show_as_rentboolean

Indicates whether this surcharge should be shown as rent.

type'complex' | 'rate_adjustment' | 'guest_fee' | 'pet_fee' | 'cleaning_fee' | 'linen_fee' | 'other_fee' | 'length_of_stay_discount' | 'last_minute_discount' | 'early_bird_discount' | 'audience_promotion' | 'member_promotion' | 'new_listing_discount' | 'high_rated_guest_discount'

updated_utcstring date-time nullable

The date and time this record was last updated (UTC).

discount_codestring

The discount code for code-based discounts (maximum 64 characters). Required when Mode is Code.

is_discount_code_exclusiveboolean

Indicates whether this discount code should remove all other discounts when applied.