CancelResponse

booking object

id string

The unique booking ID in the system

partnerBookingId string

The booking ID from the partner system

status string

The status of the booking

Possible values: [CONFIRMED, PENDING, CANCELLED]

checkInDate date

Check-in date for the booking

checkOutDate date

Check-out date for the booking

propertyId string

The ID of the property

roomId string

The ID of the room booked

roomName string

The name of the room

totalRooms integer

Total number of rooms booked

nettPrice object

The net price for the booking

currency string

amount float

taxes object[]

List of taxes

Array [

name string

Tax name.

Possible values: [Taxes and Fees]

amount float

Tax amount.

currency string

Tax currency.

]

additionalCharges object[]

List of additional charges the users need to pay at the hotel

Array [

name string

Additional charge name.

Possible values: [VAT, City Tax, Destination Taxes, Resort Fees, Service Charges, Other Local Tax, Other Hotel Fee]

amount float

Charge amount.

currency string

Currency code.

]

boardBasis string

The meal plan for the booking (e.g., "Breakfast")

Possible values: [All Inclusive, Full Board, Half Board, Breakfast, Room Only]

isFreeCancellation boolean

Whether the booking is eligible for free cancellation

cancellationPolicy object[]

Cancellation policy details

Array [

from date-time

Start date for the cancellation policy period

to date-time

End date for the cancellation policy period

amount float

Amount charged for cancellation during this period

currency string

Currency of the cancellation amount

]

bookingNotes object[]

Array [

text string

Additional booking notes provided by the hotel.

]

additionalInfo object[]

Additional information about the booking

Array [

key string

value string

]

createdAt date-time

When the booking was created

refund object

Refund information, if applicable

amount number

currency string

cancelledAt date-time

When the booking was cancelled, if applicable

CancelResponse

{
  "booking": {
    "id": "WH24355281",
    "partnerBookingId": "WP1234",
    "status": "CONFIRMED",
    "checkInDate": "2024-05-18",
    "checkOutDate": "2024-05-20",
    "propertyId": "258278",
    "roomId": "26582",
    "roomName": "Room - 2 Twin, Sofa Bed",
    "totalRooms": 3,
    "boardBasis": "Breakfast",
    "isFreeCancellation": false,
    "createdAt": "2024-08-06T00:00:00",
    "cancelledAt": null,
    "nettPrice": {
      "currency": "USD",
      "amount": 162.51
    },
    "taxes": [
      {
        "name": "Taxes and Fees",
        "currency": "USD",
        "amount": 13.49
      }
    ],
    "additionalCharges": [
      {
        "name": "Service Charges",
        "currency": "MYR",
        "amount": 3
      }
    ],
    "cancellationPolicy": [
      {
        "from": "2024-10-14 18:00",
        "to": "2024-11-18 18:00",
        "amount": 176,
        "currency": "USD"
      }
    ],
    "additionalInfo": [
      {
        "key": "Supplier Name",
        "value": "Hotelbeds"
      },
      {
        "key": "VAT Numer",
        "value": "100035906500003"
      }
    ],
    "bookingNotes": [
      {
        "text": "Check-in instructions - Extra-person charges may apply and vary depending on property policy Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges"
      }
    ]
  }
}