RatePlan

Get a rate plan

Get a rate plan by id.

To be able to read a corporate rate plan a client must additionaly have 'rateplans.read-corporate' scope assigned.<br>You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.rate_plans.read'.

get/rateplan/v0-nsfw/rate-plans/{id}

Request

Base URL
https://api.apaleo.com (the document declares no server; this is the origin it was published from)
URL
https://api.apaleo.com/rateplan/v0-nsfw/rate-plans/{id}
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: rateplans.read, setup.read, setup.manage, admin

Path parameters

idstring required

The id of the rate plan.

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2)

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: property, cancellationPolicy. All other values will be silently ignored.

Response

Return all the rate plan data.

idstring required

The rate plan id

codestring required

The code for the rate plan that can be shown in reports and table views

nameobject required

The name for the rate plan

descriptionobject required

The description for the rate plan

minGuaranteeType'PM6Hold' | 'CreditCard' | 'Prepayment' | 'Company' required

The minimum guarantee to be provided when this rate plan is booked so the reservation will be guaranteed to the guest

priceCalculationMode'Truncate' | 'Round'

The calculation mode is used when calculating the adults' surcharges and derived rates. Defaults to Truncate. Example: for a rate of 125.99 and a surcharge of +10%, when Truncate is selected, the result would be 125.99 + 12 = 137.99 When Round is selected, the result would be 125.99 + 12.60 = 138.59

channelCodesstring[] required

The channel codes the rate plan is sold through

promoCodesstring[] nullable

The rate codes for promotional and hidden rates. If at least one code is set the rate will be not publicly visible anymore and only be offered when one of the promo codes is given in the offer request. For backward compatibility it is still not possible to set multiple promo codes.

isBookableboolean required

Indicates whether the rate plan has an active booking period

isSubjectToCityTaxboolean required

Whether the rate plan is subject to city tax or not. Default value is true

isDerivedboolean required

Indicates whether the rates for this rate plan are derived from another rate plan

derivationLevelinteger required

Indicates the derivation level of the rate plan. When zero, it is a rate plan with manually managed prices.

isYieldableboolean

Whether the rate plan is subject to evaluation against hurdle rates when deciding on rate availability.

isArchivedboolean nullable

Whether the rate plan is archived or not

Example response

{
  "id": "MUC-NONREF-DBL",
  "code": "NONREF",
  "name": {
    "de": "Nicht Stornierbar",
    "en": "Non Refundable"
  },
  "description": {
    "de": "Nicht Stornierbar",
    "en": "Non Refundable"
  },
  "minGuaranteeType": "PM6Hold",
  "priceCalculationMode": "Truncate",
  "property": {
    "id": "MUC",
    "code": "MUC",
    "name": "Demo Hotel Munich",
    "description": "This is the demo hotel Munich"
  },
  "unitGroup": {
    "id": "MUC-DBL",
    "code": "DBL",
    "name": "Double",
    "description": "Double",
    "type": "BedRoom"
  },
  "cancellationPolicy": {
    "id": "MUC-FLE",
    "code": "FLE",
    "name": "Flexible",
    "description": "Free cancellation until 36 hours before arrival."
  },
  "noShowPolicy": {
    "id": "MUC-NONREF",
    "code": "NONREF",
    "name": "Non Refundable",
    "description": "Non Refundable"
  },
  "channelCodes": [
    "Direct",
    "BookingCom",
    "Ibe"
  ],
  "accountingConfigs": [
    {
      "state": "Unknown",
      "vatType": "Normal",
      "serviceType": "FoodAndBeverages",
      "subAccountId": "ALCO",
      "validFrom": "2021-01-01"
    }
  ],
  "promoCodes": [
    "APA55100",
    "DISCOUNT20"
  ],
  "timeSliceDefinition": {
    "id": "MUC-NIGHT",
    "name": "Over Night",
    "template": "OverNight",
    "checkInTime": "17:00:00",
    "checkOutTime": "10:00:00"
  },
  "restrictions": {
    "minAdvance": {
      "hours": 12,
      "days": 180
    },
    "maxAdvance": {
      "months": 24
    }
  },
  "bookingPeriods": [
    {
      "from": "2026-10-02T14:55:37.641922+02:00",
      "to": "2026-10-16T14:55:37.641922+02:00"
    },
    {
      "from": "2026-10-19T14:55:37.641922+02:00",
      "to": "2026-12-08T14:55:37.641922+02:00"
    }
  ],
  "isBookable": false,
  "isSubjectToCityTax": false,
  "pricingRule": {
    "baseRatePlan": {
      "id": "MUC-NONREF_SGL",
      "code": "NONREF",
      "name": "Non Refundable",
      "description": "Non Refundable",
      "isSubjectToCityTax": false
    },
    "type": "Absolute",
    "value": 20
  },
  "isDerived": true,
  "derivationLevel": 1,
  "surcharges": [
    {
      "adults": 2,
      "type": "Absolute",
      "value": 10
    }
  ],
  "ageCategories": [
    {
      "id": "MUC-BABY",
      "surcharges": [
        {
          "adults": 1,
          "value": 20
        },
        {
          "adults": 2,
          "value": 15.5
        }
      ]
    }
  ],
  "includedServices": [
    {
      "serviceId": "MUC-WLAN",
      "grossPrice": {
        "amount": 5,
        "currency": "EUR"
      }
    }
  ],
  "companies": [
    {
      "id": "MUC-APA",
      "code": "APA",
      "corporateCode": "APA-DBL",
      "name": "apaleo"
    }
  ],
  "ratesRange": {
    "from": "2026-10-29",
    "to": "2026-11-18"
  },
  "marketSegment": {
    "id": "CORP",
    "code": "CORP",
    "name": "Corporate Groups"
  },
  "isYieldable": false,
  "isArchived": true
}

Changes

No recorded changes to this operation across all 4 revisions of this API.