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
Pricing
objectroom_subtotal = Σ nightly_rates × rooms. Percentage taxes apply to
(room_subtotal − discount_total + add_ons_total); fixed taxes per room, per adult or per stay.
total = room_subtotal − discount_total + add_ons_total + tax_total.
Example:{"currency":"USD","nights":3,"rooms":1,"nightly_rates":[{"date":"2026-12-04","amount":"427.00"},{"date":"2026-12-05","amount":"449.00"},{"date":"2026-12-06","amount":"388.00"}],"average_nightly_rate":"421.33","room_subtotal":"1264.00","discounts":[{"code":"KONGWEEKEND","name":"King of the Weekend","amount":"151.68"}],"discount_total":"151.68","add_ons":[{"code":"BRKFST","name":"Breakfast","pricing_unit":"per_guest_per_night","unit_price":"34.00","quantity":1,"amount":"204.00"}],"add_ons_total":"204.00","taxes":[{"code":"NYC_OCC","name":"NY state & city occupancy tax","type":"percent","rate":"14.75","amount":"194.16"},{"code":"NYC_UNIT","name":"NYC hotel unit fee","type":"per_room_per_night","rate":"2.00","amount":"6.00"},{"code":"NYC_JAVITS","name":"Javits Center fee","type":"per_room_per_night","rate":"1.50","amount":"4.50"}],"tax_total":"204.66","total":"1520.98"}
currencystring
Example:USD
nightsinteger
roomsinteger
nightly_ratesarray[object]
Per-room rate for each night after the rate plan’s adjustment.
Show Child Parameters
average_nightly_ratestring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
room_subtotalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
discountsarray[object]
Show Child Parameters
discount_totalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
add_onsarray[object]
Show Child Parameters
add_ons_totalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
taxesarray[object]
Show Child Parameters
tax_totalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
totalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
Example
Offer
objectrate_planobject
Show Child Parameters
pricingobject
room_subtotal = Σ nightly_rates × rooms. Percentage taxes apply to
(room_subtotal − discount_total + add_ons_total); fixed taxes per room, per adult or per stay.
total = room_subtotal − discount_total + add_ons_total + tax_total.
Example:{"currency":"USD","nights":3,"rooms":1,"nightly_rates":[{"date":"2026-12-04","amount":"427.00"},{"date":"2026-12-05","amount":"449.00"},{"date":"2026-12-06","amount":"388.00"}],"average_nightly_rate":"421.33","room_subtotal":"1264.00","discounts":[{"code":"KONGWEEKEND","name":"King of the Weekend","amount":"151.68"}],"discount_total":"151.68","add_ons":[{"code":"BRKFST","name":"Breakfast","pricing_unit":"per_guest_per_night","unit_price":"34.00","quantity":1,"amount":"204.00"}],"add_ons_total":"204.00","taxes":[{"code":"NYC_OCC","name":"NY state & city occupancy tax","type":"percent","rate":"14.75","amount":"194.16"},{"code":"NYC_UNIT","name":"NYC hotel unit fee","type":"per_room_per_night","rate":"2.00","amount":"6.00"},{"code":"NYC_JAVITS","name":"Javits Center fee","type":"per_room_per_night","rate":"1.50","amount":"4.50"}],"tax_total":"204.66","total":"1520.98"}
Show Child Parameters
cancellationobject
The policy applied to a specific stay, with a concrete deadline and penalty amount.
Show Child Parameters
Example