CLcloudbeds
Rate Plans

Get Rate Plan data.

get/rates/v1/rate-plans/{id}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/rates/v1/rate-plans/{id}
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:rate

Path parameters

idId required(unresolved $ref)

Rate Plan ID.

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

Rate Plan data.

idstring
propertyIdstring nullable
isActiveboolean
status'active' | 'expired' | 'no-intervals' | 'disabled'

Derived from isActive and the intervals' end dates, using the property's current date. disabled: isActive is false. no-intervals: active with no intervals. expired: active and every interval's endDate is in the past. active: active with at least one interval whose endDate is today or later (or has no endDate).

isDeletedboolean
derivedRatePlanIdstring nullable
isDerivedboolean
derivedTypestring nullable
derivedValuenumber float nullable
promoCodestring nullable
sourcesstring[] nullable
nameobject nullable
descriptionobject nullable
namePrivateobject nullable
termsobject nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
policyIdstring nullable
segmentIdstring nullable
mealPlansstring[] required

Meal plans carried by the add-ons listed in addons (any attachment setting), as raw keys (not localized labels), deduplicated. Empty when none of them is a meal plan.

Example response

{
  "propertyId": "9876",
  "isActive": true,
  "status": "active",
  "derivedRatePlanId": "456",
  "isDerived": true,
  "derivedType": "fixed",
  "derivedValue": 150.5,
  "addons": [
    {
      "id": "1234567",
      "addonId": "4674899",
      "settings": "package_inclusive"
    }
  ],
  "promoCode": "SUMMER2023",
  "sources": [
    "source1",
    "source2"
  ],
  "name": {
    "en": "Standard Rate",
    "es": "Tarifa Estándar"
  },
  "description": {
    "en": "Our standard rate plan",
    "es": "Nuestro plan de tarifas estándar"
  },
  "namePrivate": {
    "en": "Standard Internal",
    "es": "Estándar Interno"
  },
  "terms": {
    "en": "Standard terms apply",
    "es": "Se aplican términos estándar"
  },
  "intervals": [
    {
      "name": "BaseRate1",
      "ratePlanId": 123,
      "roomTypeId": 456,
      "startDate": "2025-07-03",
      "endDate": "2025-07-10",
      "minLos": 1,
      "days": [
        60,
        50,
        50,
        50,
        50,
        65.99,
        65.99
      ],
      "adultDays": {
        "1": {
          "3": 20,
          "4": 20
        },
        "5": {
          "3": 35,
          "4": 35
        }
      },
      "childDays": {
        "1": {
          "1": 5,
          "2": 10
        },
        "5": {
          "1": 10,
          "2": 15
        }
      },
      "cutOff": 3,
      "lastMinuteBooking": 1,
      "limitToNumberOfRooms": 5,
      "agePolicyPricing": [
        {
          "ageGroupId": 7,
          "extraGuestsType": "per_age_group",
          "days": [
            {
              "dayOfWeek": 1,
              "priceAmount": "12.00",
              "priceCurrency": "USD"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-10-01T12:00:00+00:00",
  "updatedAt": "2023-10-01T12:00:00+00:00",
  "policyId": "9888000",
  "segmentId": "789",
  "mealPlans": [
    "breakfast",
    "dinner"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.