Rate Plan

Rate Plan is the price or cost charged by the hotel per night. Rate Plan is the term given to different rates you see on a hotel website when you search for a set of dates.

---

Create or Update Rate Plan

Create or update rate plan API is used to build new rates or add missing rates. It is also possible to change the rate name or remove an existing rate plan.

---

Request (RQ) Sent with STAAH Rate-Level Build Data

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/OTA_HotelRatePlan

---

Send a request with STAAH rate level build data which consists of a set of predefined parameters.

Attributes

---

Rate Plans hotelid / HotelCode / ClientID string (Required)

The existing property ID. Required existing id to create or update rate plans.

Maximum 20 characters allowed.

---

RatePlan array

RatePlan array contains the different rate plans for the property.

---

RatePlanNotifType string (Required)

Indicates whether the call is meant to create new rateplan or update an existing one for property.

Accepts values: [New, Overlay, Remove, Activate].

To create use New and to update rateplan, see Change, Activate, Deactivate, and Delete.

---

rateplanid / RatePlanID string (Required)

The rateplan ID as assigned by the provider.

Accepts alphanumeric values and "-" (Hyphen).

Space and Special characters are not allowed.

Maximum 20 characters allowed.

---

MealPlanID string (Optional)

Name of the MealPlan. See Meal Plan.

Accepts the values listed under MP.

If wrong mealplanID sent, then it will take default value.

Default: 15 (Room Only).

---

closeoutdays number (Optional)

The closeoutdays as allocated by the provider for rateplan.

Accepts the values between 0 to 30 but must be in quotes. Default value is -1(no closeouts).

---

closeouttime string (Optional)

The closeouttime as allocated by the provider for rateplan.

Accepts the values between 00:00 to 24:00(Interval must be 30 min). It is required only if you set closeoutdays value as 0. Default value is -1(no closeouts).

---

Description object

This object contains the name of the rate plan and the additional note about the rate plan.

---

Name string (Required)

The rate plan name.

---

Text string (Optional)

Additional detail or specific note about the rate plan.

Sample Request

{
	"RatePlans": {
		"hotelid": "KC",
		"RatePlan": [{
				"RatePlanNotifType": "New",
				"rateplanid": "BAR",
				"MealPlanID": "1",
		                "closeoutdays": "0",
		                "closeouttime": "00:30",
				"Description": {
					"Name": "BAR",
                                        "Text" : "Best Rate Available Rate Plan"
				}
			},
			{
				"RatePlanNotifType": "New",
				"rateplanid": "RACK",
				"MealPlanID": "2",
				"Description": {
					"Name": "RACK",
                                        "Text" : "max Daily Rate of the Rate Plan"
				}
			}
		]
	}
}

---

Response

Sample Success Response

{
  "Status": "Success"
}

---

Example - Change Rate Plan Name

Attributes

---

Refer Request attributes.

Sample Request

{
   "RatePlans": {
      "hotelid": "KC",
      "RatePlan": [{
         "RatePlanNotifType": "Overlay",
         "rateplanid": "12345889Ab",
         "MealPlanID": "2",
         "Description": {
            "Name": "Early booker rate",
            "Text": "Change can be made here"
         }
      }]
   }

---

Example - Deactivate Rate Plan

Attributes

---

Refer Request attributes.

Sample Request

{
    "RatePlans": {
        "hotelid": "KC",
        "RatePlan": [{
            "RatePlanNotifType": "Remove",
            "rateplanid": "BAR"
        }]
    }
}

---

Example - Activate Rate Plan

Attributes

---

Refer Request attributes.

Sample Request

{
    "RatePlans": {
        "hotelid": "WA",
        "RatePlan": [{
            "RatePlanNotifType": "Activate",
            "rateplanid": "BAR"
        }]
    }
}

---

Example - Delete Rate Plan

Attributes

---

Refer Request attributes.

Sample Request

{
    "RatePlans": {
        "hotelid": "KC",
        "RatePlan": [{
            "RatePlanNotifType": "Delete",
            "rateplanid": "BAR"
        }]
    }
}

---

Response

Sample Success Response

{
  "Status": "Success"
}