Managing rate plans

Rate plans are labels or categories used to organise prices for a property.

How does Booking.com define a rate plan?

A rate plan is simply a name you use to organise prices. To add conditions such as a cancellation policy, prepayment policy, and meal plan, you must create a roomrate.

→ To learn more about rate plans, conditions, and roomrates, see basic definitions.

What falls under managing rate plans?

Managing rate plans involves the following actions:

• Creating and updating rate plans.
• Retrieving active and deactivated rate plans.
• Deactivating and activating rate plans.

Mapping room types and rate plans

To map your room types and rate plans to Booking.com's, you should use the retrieving roomrates endpoint. You could also use the retrieving room types and retrieving rate plans endpoints, but these contain less complete information. You could still use either to troubleshoot issues with mapping as needed.

What is the maximum number of rate plans the API supports?

You can create a maximum of 100 active rate plans for a property.

Creating a rate plan

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

The POST /ota/OTA_HotelRatePlanNotif request enables you to create a rate plan for your property.

Creating and updating

To create a rate plan you set RatePlanNotifType to New. If you want to update a rate plan, you set RatePlanNotifType to Overlay. In reality, updating a rate plan through this API is just renaming it.

Requirements for creating a room type

To create a rate plan on Booking.com, the following elements are required:

• Property ID.
• Rate plan name.

Body parameters

The following table describes the elements you must add in the request body:

Request body example

The following is a request body example:

<OTA_HotelRatePlanNotifRQ>
  <RatePlans HotelCode="6314570" >
    <RatePlan RatePlanNotifType="New" RatePlanID="123456">
      <Description Name="Summer Rate"/>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelRatePlanNotifRS>
    <RatePlanCrossRefs>
        <RatePlanCrossRef RequestRatePlanCode="123456" ResponseRatePlanCode="19617122"/>
    </RatePlanCrossRefs>
    <Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetwbMG/FMpzy/DyRiLnoKEGBZ3R] -->

The following is a response body example when the limit of 100 rate plans is reached:

<OTA_HotelRatePlanNotifRS>
    <Errors>
        <Error Type="10" Code="562" Status="NotProcessed" ShortText="Limit 100 of number of Rates has reached."/>
    </Errors>
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetwbMG/FMpzy/QM5cwDyRiLnoKEGBZ3Rcslghlzsoierhgvs3efsve] -->

Response body parameters

The following table describes the response elements:

Updating a rate plan

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

The POST /ota/OTA_HotelRatePlanNotif request enables you to create a rate plan for your property.

To update a rate plan, you must:

• Set RatePlanNotifType to Overlay.
• Specify the Booking.com rate plan ID in RatePlanCode.

→ To retrieve rate plans and their RatePlanCode, see retrieving rate plans.

Requirements for updating a rate plan

To create a rate plan on Booking.com, the following elements are required:

• Property ID
• Rate plan name
• Rate plan ID

Body parameters

The following table describes the elements you must add in the request body:

Request body example

The following is a request body example:

<OTA_HotelRatePlanNotifRQ>
  <RatePlans HotelCode="6314570" >
    <RatePlan RatePlanNotifType="Overlay" RatePlanCode="19617122" RatePlanID="123456">
      <Description Name="Summer non-refundable Rate"/>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelRatePlanNotifRS>
    <RatePlanCrossRefs>
        <RatePlanCrossRef RequestRatePlanCode="123456" ResponseRatePlanCode="19617122"/>
    </RatePlanCrossRefs>
    <Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetwbMG/FMpzy/DyRiLnoKEGBZ3R] -->

Response body parameters

The following table describes the response elements:

Retrieving rate plans

POST https://supply-xml.booking.com/hotels/xml/rates

The POST /xml/rates request enables you to retrieve rate plans of a property, where you can further specify the following:

• 1: Returns all rate plans.
• 3: Returns all active rate plans.
• 6: Returns all deactivated rate plans.

Body parameters

The following table describes the elements you must add in the request body:

Request body example

The following is a request body example:

<request>
   <hotel_id>6314570</hotel_id>
   <show_rates_status>1</show_rates_status>
</request>

Response body example

The following is a successful response body example:

<rates>
    <rate id="18045111" active="1" hotel_id="6314570" hotel_name="The Tech W">Non-refundable rate</rate>
    <rate id="19454895" active="1" hotel_id="6314570" hotel_name="The Tech W">Fully flexible</rate>
    <rate id="20275653" active="0" hotel_id="6314570" hotel_name="The Tech W">Standard rate</rate>
    <rate id="20442599" active="0" hotel_id="6314570" hotel_name="The Tech W" is_child_rate="1">basic rate extended</rate>
</rates>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YUPwiuucSHwvOzUg7gohCzo+vRzq/WYNpZcFinFyrhAIH9Bw+Rgsf2Km] -->

Response body parameters

The following table describes the response elements:

Deactivating a rate plan

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

The POST /ota/OTA_HotelRatePlanNotif request enables you to deactivate an active rate plan. To do so, you must:

• Set RatePlanNotifType to Remove.
• Specify the rate plan ID in RatePlanCode.

Removing is not deleting

You cannot delete rate plans, only deactivate them. This is important, because deactivated rate plans could still cause naming conflicts if you create a new rate plan with the same name.

Deactivating causes roomrates to be deactivated

If you deactivate a rate plan, all roomrates (products) you have created for a property with this rate plan become deactivated as well. This also means any inventory or availability is removed.

If you decide to activate a deactivated rate plan, you must both create roomrates and push inventory (availability) again.

Body parameters

The following table describes the elements you must add in the request body:

Request body example

The following is a request body example:

<OTA_HotelRatePlanNotifRQ>
  <RatePlans HotelCode="123456" >
    <RatePlan RatePlanNotifType="Remove" RatePlanCode="12345601" />
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelRatePlanNotifRS>
<Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetwbMG/FMpzy/QM5co5D+dedwfwwDyRiLnoKEGBZ3R] -->

Response body parameters

The following table describes the response elements:

Activating a rate plan

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

The POST /ota/OTA_HotelRatePlanNotif request enables you to reactivate a previously deactivated rate plan. To do so, you must:

• Set RatePlanNotifType to Activate.
• Specify the rate plan ID in RatePlanCode.

Body parameters

The following table describes the elements you must add in the request body:

Request body example

The following is a request body example:

<OTA_HotelRatePlanNotifR>
  <RatePlans HotelCode="123456" >
    <RatePlan RatePlanNotifType="Activate" RatePlanCode="12345601" />
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelRatePlanNotifRS>
<Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetwbdwdfy/QM5co5D+dedwEGBZ3R] -->

Response body parameters

The following table describes the response elements:

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

<OTA_HotelRatePlanNotifRQ>
  <RatePlans HotelCode="12345">
    <RatePlan RatePlanNotifType="New">
      <Description Name="Basic rate 2 guests"/>
      <RateRelation ParentRateId="54321"
                    Percentage="90"
                    FollowsPrice="1"
                    FollowsRestrictions="1"
                    FollowsPolicyGroup="1"
                    FollowsClosed="1">
      </RateRelation>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

<OTA_HotelRatePlanNotifRS>
    <RatePlanCrossRefs>
        <RatePlanCrossRef RequestRatePlanCode="123490" ResponseRatePlanCode="19617133"/>
    </RatePlanCrossRefs>
    <Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetdwdwo5Dcz0GswDyRiLnoKEGBZ3R] -->

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelRatePlanNotif

<OTA_HotelRatePlanNotifRQ>
  <RatePlans HotelCode="12345">
    <RatePlan RatePlanNotifType="Overlay" RatePlanCode="543216">
      <Description Name="Basic rate 2 guests"/>
      <RateRelation ParentRateId="54321"
                    Percentage="80"
                    FollowsPrice="1"
                    FollowsRestrictions="1"
                    FollowsPolicyGroup="1"
                    FollowsClosed="0">
      </RateRelation>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

<OTA_HotelRatePlanNotifRS>
  <Success />
</OTA_HotelRatePlanNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YWVEetdwdyRiLnoKEGBZ3R] -->