Overview
Retrieves a specific rate plan by its ID, including base rates, guest applicability, and optional date-specific restrictions.Request
GET /v1/ratePlans/{ratePlanId}
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Api-Key | string | Yes | Your API key for authentication. |
Channel-Id | string | Yes | Your distribution channel identifier. |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ratePlanId | string | Yes | Unique identifier of the rate plan. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fromDate | string (date) | No | Start date for retrieving rate restrictions. |
toDate | string (date) | No | End date for retrieving rate restrictions. |
Example Request
curl -X GET "https://sandbox.elivaas.com/v1/ratePlans/rp_123?fromDate=2025-08-01&toDate=2025-08-07" \
-H "Api-Key: YOUR_API_KEY" \
-H "Channel-Id: YOUR_CHANNEL_ID"
Response — 200 OK
Returns a single RatePlan object.
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the rate plan. |
propertyId | string | Property this rate plan belongs to. |
name | string | Display name. |
code | string | Code identifier (e.g., european-plan). |
description | string | What the rate plan includes. |
rate | integer | Base rate per night. |
minimumRate | integer | Minimum rate (floor price). |
extraAdultRate | integer | Surcharge per extra adult per night. |
extraChildRate | integer | Surcharge per extra child per night. |
applicableGuest | integer | Total guests included in base rate. |
applicableAdult | integer | Adults included in base rate. |
applicableChild | integer | Children included in base rate. |
restrictions | array of DateRestriction | Date-specific rate overrides. Only populated when dates are provided. |
Example Response
{
"id": "rp_123",
"propertyId": "prop_456",
"name": "Standard Room Rate",
"code": "european-plan",
"description": "Room only - no meals included",
"rate": 1500,
"minimumRate": 1200,
"extraAdultRate": 300,
"extraChildRate": 150,
"applicableGuest": 2,
"applicableAdult": 2,
"applicableChild": 1,
"restrictions": [
{
"date": "2025-08-01",
"rate": 1500,
"stopSell": false
},
{
"date": "2025-08-02",
"rate": 1800,
"stopSell": false
}
]
}
Error Handling
| Status | Meaning | Description |
|---|---|---|
200 | Success | Rate plan returned. |
401 | Unauthorized | Missing or invalid Api-Key or Channel-Id. |
404 | Not Found | Rate plan ID does not exist. |
500 | Internal Server Error | Unexpected error. |