Sign in

v1

latestOpenAPI 3.0.02026-07-141046209.2 KB
Rate Calendar

List a rate plan (rate calendar) for a hotel (Beta endpoint).

Returns a single rate plan available for you for a hotel.

Rate plans are products the hotel is offering. They typically consist of a combination of restrictiveness in case of cancellations or changes, the time they're bookable, minimum or maximum length of stay restrictions (e.g. week-long bookings), included components like breakfast or dinner and/or the conditions under which the room can be sold (e.g. private rates that can only be offered and sold to a closed user group behind login).

Examples of rate plans:

  • Non-refundable room rate that includes breakfast
  • Room-only rate with free cancellation up to 14 days before arrival

This endpoint returns a singular available rate plan.

get/hotels/{hotelId}/rate-plans/{ratePlanId}

Response

descriptionstring required

Human-readable summary describing this rate plan.

hotelIdstring uuid required

The unique identifier of the hotel this rate plan is available for.

ratePlanIdnumber required

The integer identifier of this rate plan.

Example response

{
  "adjustments": [
    {
      "amount": 5,
      "conditions": [
        {
          "rules": {
            "bookableDateRange": {
              "end": "2021-08-23",
              "start": "2021-05-15"
            },
            "nightsRange": {
              "max": 5,
              "min": 3
            }
          }
        }
      ]
    }
  ],
  "components": [
    {
      "formatted": "breakfast",
      "type": "BREAKFAST"
    }
  ],
  "description": "NON_REFUNDABLE,DINNER",
  "roomTypes": [
    {
      "dates": [
        {
          "rates": [
            {
              "retailRate": {
                "amount": 9500,
                "currency": {
                  "code": "EUR"
                }
              }
            }
          ]
        }
      ],
      "name": "Junior Suite"
    }
  ]
}