v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Discounts

Query for a pageable list of surcharges.

get/v2/discounts

Query parameters

since_utcstring date-time nullable

Filter for records created or changed since a specific date (UTC).

activeboolean nullable

Filter by active status.

typeSurchargeType[] nullable

Filter by surcharge type (comma-separated, e.g. CleaningFee,LengthOfStayDiscount).

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'

Filter by income category.

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

Filter by surcharge mode (Automatic, Optional, Manual, Code, Offline).

property_idinteger nullable

Filter to surcharges applicable to a specific property.

Response

A pageable list of view models.

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.