Create a rate plan (beta)

Closed beta

This API is in closed beta. You can't use it unless you have been invited as a beta tester.

A rate plan contains the name of a rate. Use /ota/OTA_HotelRatePlanNotif to create rate plans.

What are these Rate Relations (beta)?

This feature allows you to have one rate follow certain properties of another rate. Some discounts and rates with special conditions are set up in this way. Most attributes of the rate are set to be either followed or not followed. However, the price can be followed with additional modifications applied, such as a percentage (e.g. 90% of the original price). Also, the overlay works in the way you can set any rate previously created to follow another rate of your choice, or remove the rate relation all together.

Before you start

You need:


HTTP request


Request Attribute(@) Overview

Field Description Type Required Notes
RateParent Root node for parent Rate object Optional -
RateRelation Root node for the child rate relation object Optional -
RateParentId Id of the parent Rate Integer Required for new, Optional for overlay(If you skip this the existing rate relation will be deleted)((within RateRelation)) Default: 1.0
Percentage Percentage change from parent rate integer Required Min/max value: 1/200
FollowsPrice Follows price changes of parent Boolean Optional Format: 0/1 Default: 1
FollowsRestrictions Follows restrictions on the parent rate Boolean Optional Format: 0/1 Default: 1
FollowsPolicyGroup Follows policy group of the parent Boolean Optional Format: 0/1 Default: 1
FollowsClosed Follows open/closed status of the parent Integer Optional Min/max value: 1/3

Request body

Provide an OTA_HotelRatePlanNotifRQ object with the RateRelation object in the request body. Example:

<?xml version="1.0" encoding="UTF-8"?>
  <!-- Replace the {PlaceHolder} in the following line! -->
  <RatePlans HotelCode="{PropertyID}">
    <RatePlan RatePlanNotifType="New">
      <Description Name="Basic rate 2 guests"/>
      <RateRelation ParentRateId="123454" Percentage = "90"
                    FollowsPrice = "1"
                    FollowsRestrictions = "1"
                    FollowsPolicyGroup = "1"
                    FollowsClosed = "1">


The response contains an OTA_HotelRatePlanNotifRS object:

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRS xmlns="" xmlns:xsi="" xsi:schemaLocation=" OTA_HotelRatePlanNotifRS.xsd" TimeStamp="2015-09-30T13:49:52-00:00" Target="Production" Version="3.000">
  <Success />
  <RatePlanCrossRef  ResponseRatePlanCode="{OurRatePlanID}"/>

Next steps