TaxDefinition
objectcodestring
Example:NYC_OCC
namestring
typestring
Allowed values:percentper_room_per_nightper_person_per_nightper_stay
amountnumber
A percentage for percent
Example
RoomType
objectcodestring
Example:TWRK
namestring
Example:Tower King
descriptionstring
occupancyobject
Limits per room. Every room needs at least one adult.
Show Child Parameters
bed_configurationstring
Example:1 king
size_sqminteger
viewstring | null
is_accessibleboolean
is_smokingboolean
amenitiesarray[string]
photosarray[object]
Show Child Parameters
Example
RatePlan
objectcodestring
Example:BAR
namestring
Example:Best Available Rate
descriptionstring
meal_planstring
Allowed values:room_onlybreakfasthalf_boardall_inclusive
requires_membershipboolean
allows_modificationboolean
restrictionsobject
Show Child Parameters
cancellation_policyobject
Show Child Parameters
Example
CancellationPolicy
objectcodestring
Allowed values:FLEX24FLEX48MOD7DNONREF
namestring
descriptionstring
is_refundableboolean
free_cancellation_hours_before_check_ininteger | null
penaltyobject
Show Child Parameters
Example
CancellationTerms
objectThe policy applied to a specific stay, with a concrete deadline and penalty amount.
codestring
namestring
is_refundableboolean
free_cancellation_untilstring | null(date-time)
Example:2026-12-03T16:00:00-05:00
penalty_after_deadlinestring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
currencystring
summarystring
Example:Free cancellation until Thu 3 Dec 2026, 16:00 EST. After that, 1 night(s) of room charges (427.00 USD) apply.
Example