Reservation
objectconfirmation_numberstring
Example:KH7Q4M2X9
partner_referencestring | null
statusstring
Allowed values:confirmedchecked_inchecked_outcancelledno_show
propertyobject
Show Child Parameters
room_typeobject
Show Child Parameters
rate_planobject
Show Child Parameters
check_instring(date)
check_outstring(date)
nightsinteger
roomsinteger
adultsinteger
childreninteger
children_agesarray | null[integer]
guestobject
Show Child Parameters
additional_guestsarray[object]
special_requestsstring | null
estimated_arrival_timestring | null
loyaltyobject | null
Show Child Parameters
promotion_codestring | null
payment_modelstring
pay_at_hotel: the guest pays the property; partner_collect: you collected payment and settle
with Kong Hotels under your contract (shown as a prepayment on the folio).
Allowed values:pay_at_hotelpartner_collect
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
cancellation_policyobject
The policy applied to a specific stay, with a concrete deadline and penalty amount.
Show Child Parameters
cancellationobject | null
Show Child Parameters
created_atstring(date-time)
updated_atstring(date-time)
linksobject
Show Child Parameters
Example
CancellationQuote
objectconfirmation_numberstring
is_cancellableboolean
statusstring
Allowed values:confirmedchecked_inchecked_outcancelledno_show
currencystring
totalstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
cancellation_fee
One OfMoneystring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
refundable_amount
One OfMoneystring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
policyobject
The policy applied to a specific stay, with a concrete deadline and penalty amount.
Show Child Parameters
calculated_atstring(date-time)
Example
Folio
objectconfirmation_numberstring
statusstring
Allowed values:confirmedchecked_inchecked_outcancelledno_show
currencystring
payment_modelstring
pay_at_hotel: the guest pays the property; partner_collect: you collected payment and settle
with Kong Hotels under your contract (shown as a prepayment on the folio).
Allowed values:pay_at_hotelpartner_collect
linesarray[object]
Show Child Parameters
total_chargesstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
paymentsarray[object]
Show Child Parameters
balance_due_at_propertystring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
Example
AddOn
objectcodestring
Example:BRKFST
namestring
descriptionstring
categorystring
Example:dining, flexibility, transport, wellness, activities, pets, celebration
pricing_unitstring
Allowed values:per_stayper_nightper_guest_per_night
pricestring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
currencystring
max_quantityinteger
Example
AddOnLine
objectcodestring
namestring
pricing_unitstring
Allowed values:per_stayper_nightper_guest_per_night
unit_pricestring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
quantityinteger
amountstring
Decimal amount in the property currency.
Match pattern:^-?\d+\.\d{2}$
Example:389.00
Example