Skip to main content

​
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

ParameterTypeRequiredDescription
ratePlanIdstringYesUnique identifier of the rate plan

​
Query Parameters

ParameterTypeRequiredDescription
fromDatestring (YYYY-MM-DD)NoStart date for retrieving rate restrictions
toDatestring (YYYY-MM-DD)NoEnd 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

FieldTypeDescription
idstringUnique identifier for the rate plan
propertyIdstringIdentifier of the associated property
namestringName of the rate plan
codestringCode identifying the rate plan
descriptionstringDescription of the plan
rateintegerBase rate per night
minimumRateintegerMinimum rate applicable
extraAdultRateintegerCharge per additional adult
extraChildRateintegerCharge per additional child
applicableGuestintegerTotal guests included in base rate
applicableAdultintegerAdults included in base rate
applicableChildintegerChildren included in base rate
restrictionsarrayDate-specific rate details (when date range is provided)

​
Authentication

All requests must include the following headers:
  • Api-Key: Your API key for authentication
  • Channel-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