For AI agents: the docs index is at https://developers.cloudbeds.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
- Booking Format: Clarified that a room's
Adults, Children, Babies and Occupancy are totals for all of its Units, the same as Price, so OrderAdults, OrderChildren and OrderCustomers are plain sums of the room values. For private rooms we now recommend one Rooms entry per booked room (Units = 1). Also corrected the Price relation, which left out the multiplication by Units and the extra services included in the room price, and counted taxes already in the day rates. The TotalPrice relation no longer counts extra services, taxes and discounts a second time when the room prices already include them (BookingCreate, GetBookingId, GetBookingList).
- BookingCreate, GetBookingId: The booking examples now show two rooms with two adults each, sent as one entry (
Units = 2, Adults = 4). The previous GetBookingId example (Units = 2, Adults = 2) meant one adult per room, which was easy to misread.
- Booking Format: Corrected the
ExtraService fields IncludedInDayRates and IncludedInRoomPrice. Their descriptions called the extra service a discount and said a missing value counts as true, while booking validation treats it as 0. Always send both fields.
- Booking Format: Documented the
ExtraTax field IncludedInTotal, which booking validation already required. It should be 1, since TotalPrice includes all taxes. An extra tax that is not in the day rates counts towards a room's Price or TotalPrice only when IncludedInTotal is 1.
- GetBookingId: The OpenAPI booking schema now allows
0 for OrderCustomers and a room's Occupancy, as the booking format and booking validation already did.
- CreateGroupBlock, UpdateGroupBlock:
group_block_auto_release is now typed as nullable. Cloudbeds sends null for it whenever the block has auto release switched off, which the previous schema did not allow.
- CreateGroupBlock, UpdateGroupBlock: Documented
shoulder_days_before and shoulder_days_after inside each group_block_ari room type. Both were already being sent but not specified. They count the shoulder days around the block and are not included in the data intervals.
- BookingCreate: A rejected booking now says whether the property never set your channel up (
1031) or set it up and switched it off (1034). Both cases used to answer 1031, and a property identified by ota_property_id used to answer 1001, which read as an unknown property.
- DeleteGroupBlock: Documented
group_code, which was already being sent alongside group_block_code but not specified. Use it if your system scopes block codes per group; otherwise ignore it and match on group_block_code alone.
- Booking Format: Clarified the
DayRate tax field definitions. RateBeforeTax / NetRateBeforeTax exclude only taxes applied on top of the rate (exclusive taxes) — taxes embedded in the rate (inclusive taxes) remain included; RateAfterTax / NetRateAfterTax include all taxes.
- BookingCreate: The success response now carries
acknowledgement_ids, one ID per property the booking was queued for. Each comes back as acknowledgement_id on the matching AckBooking, so a pushed booking can be tied to its acknowledgement.
- AckBooking: Added
acknowledgement_id, identifying which BookingCreate delivery is being acknowledged. Also documented version and myallocator_id, which were already being sent but not specified, and clarified that AckBooking calls are not sent in delivery order.
- GetARI, CheckAvailability: Both callbacks now accept
ota_property_sub_id, and channels that host multiple properties under one login must use it to identify the property (previously only ota_property_id was read, which cannot resolve to a single property for those channels). Channels with a single property per login are unaffected and continue to send ota_property_id.
- Callbacks: All callback endpoints (
BookingCreate, NotifyBooking, ARIFullRefresh, CheckAvailability, RoomInfo, ChannelList) now accept application/json request bodies, and JSON is the documented request format. With a JSON body, booking_json may be embedded directly as a JSON object. Existing integrations using application/x-www-form-urlencoded continue to work.
- Booking Format: Added optional
DayRate fields for precise per-day pricing: RateBeforeTax / RateAfterTax (gross, guest-facing rate excluding/including taxes) and NetRateBeforeTax / NetRateAfterTax (net rate after channel commission, i.e. what the property receives). Values must satisfy RateBeforeTax <= RateAfterTax, NetRateBeforeTax <= NetRateAfterTax, and each net field <= its gross counterpart (BookingCreate, GetBookingId, GetBookingList).
- Booking Format: Corrected
SeriesCode type from Int >= 0 to String. CardNumber and SeriesCode must be encoded as JSON strings (quoted values), never as bare JSON numbers, so the PCI-compliant secure card endpoint can tokenize them (BookingCreate, GetBookingId).
- BookingCreate, GetBookingId: Documented credit/debit card data handling. Card data is no longer accepted at the standard
BookingCreate endpoint — bookings containing card data must be sent to a dedicated, PCI-compliant endpoint provided by Cloudbeds, authenticated with a Cloudbeds-provided header or an allow-listed IP. A PCI Attestation of Compliance (AoC) is required and the channel must be configured by Cloudbeds before card data can be exchanged. Until a channel is enabled for card handling, bookings with card data are rejected via BookingCreate and silently not imported via GetBookingId.
- UpdateRatePlan: Documented that
min_occupancy and max_occupancy are not currently populated by Cloudbeds (always sent as 0) and should be ignored by partners.
- Taxes: Added
municipal_tax to the tax category enum (CreateProperty, UpdateTaxes).
- Taxes: Added
length-of-stay-progressive and length-of-stay-retroactive to the tax condition_parameter enum (CreateProperty, UpdateTaxes).
- ChannelList: Added new method to get a list of Cloudbeds channels with their IDs and names
- CreateProperty, UpdateRoom, UpdateRatePlan: Added optional
refundable and refundable_until_days fields for a rate plan.
- CreateProperty: Added optional
ota_property_sub_id response parameter. For channels that support multiple properties under one account, this sub-property ID will be saved by Cloudbeds and included in future API calls for the property.
- UpdateProperty: Added new method to update general property data
- CreateProperty, UpdateRoom: Added
max_adults and max_children fields
- Documentation: Improved OpenAPI documentation structure and added new required fields to booking format
- Booking Format: Added new mandatory fields to booking schema
- CreateProperty, UpdateRoom, UpdateRatePlan: Added
meal_codes field to support meal plan information (All-Inclusive, Breakfast, Lunch, Dinner)
- UpdateRoom, UpdateRatePlan: Added mapping return fields in responses to automatically map OTA IDs to Cloudbeds IDs
- Groups: Added group booking support with new methods:
CreateGroup, UpdateGroup, DeleteGroup, CreateGroupBlock, UpdateGroupBlock, DeleteGroupBlock
- Booking Format: Enhanced broker/CRS support with detailed documentation for
OrderSource, OrderSourceId, ExternalReferences, and SourceTree fields
- AckBooking: Added new method to acknowledge successful booking receipt
- Payment: Added support for new card types: Cabal, ItalCred, Naranja, and Nativa
- UpdateRoom: Added missing
ota_room_id field
- Booking Format: Added
DepositType field
- Booking Format: Extended booking format with additional fields
- UpdateRatePlan, DeleteRatePlan: Added new methods for rate plan management
- Room Data: Added gender field to room data for dormitory support
- UpdateRoom, DeleteRoom: Added new methods for room management
- UpdateTaxes: Added new method to manage property taxes and fees
- CreateProperty: Added taxes and fees support in property creation
- Endpoints: Moved to single endpoint URLs (all methods can use the same base URL)
- CreateProperty: Added
rateplans field for rooms
- CreateProperty: Added new fields:
images, description, check_in_time, check_out_time
