Documentation Index
Fetch the complete documentation index at: https://docs.elivaas.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Rate Plans Retrieve API allows you to get detailed information about a specific rate plan, including its base rates, guest applicability, and optional date-specific restrictions.
Retrieving a Rate Plan
GET /v1/ratePlans/{ratePlanId}
Path Parameters
| Parameter | Type | Required | Description |
|---|
| ratePlanId | string | Yes | Unique identifier of the rate plan |
Query Parameters
| Parameter | Type | Required | Description |
|---|
| fromDate | string (YYYY-MM-DD) | No | Start date for retrieving rate restrictions |
| toDate | string (YYYY-MM-DD) | No | End date for retrieving rate restrictions |
Example Request (Basic)
curl -X GET "https://api.elivaas.com/api/v1/ratePlans/rp_123" \
-H "Api-Key: YOUR_API_KEY" \
-H "Channel-Id: YOUR_CHANNEL_ID"
Example Request (With Date Restrictions)
curl -X GET "https://api.elivaas.com/api/v1/ratePlans/rp_123?fromDate=2025-08-01&toDate=2025-08-07" \
-H "Api-Key: YOUR_API_KEY" \
-H "Channel-Id: YOUR_CHANNEL_ID"
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
},
{
"date": "2025-08-03",
"rate": 1800,
"stopSell": false
}
]
}
Response Fields
| Field | Type | Description |
|---|
| id | string | Unique identifier for the rate plan |
| propertyId | string | Identifier of the associated property |
| name | string | Name of the rate plan |
| code | string | Code identifying the rate plan |
| description | string | Description of the plan |
| rate | integer | Base rate per night |
| minimumRate | integer | Minimum rate applicable |
| extraAdultRate | integer | Charge per additional adult |
| extraChildRate | integer | Charge per additional child |
| applicableGuest | integer | Total guests included in base rate |
| applicableAdult | integer | Adults included in base rate |
| applicableChild | integer | Children included in base rate |
| restrictions | array | Date-specific rate details (when date range is provided) |
Authentication
All requests must include the following headers:
Api-Key: Your API key for authenticationChannel-Id: Identifier for the channel making the request
Error Handling
The API returns standard HTTP status codes:
- 200: Success
- 401: Unauthorized
- 404: Rate plan not found
- 500: Internal Server Error
