Rate

Initializes and changes the rates for the rate plan.

All rates specified in the request will be initialized, or overwritten if they already exist.

Make sure that the from and to date and time in the rates match the time slice definition of the rate plan. The easiest way to achieve this is calling the GET /rate-plans/{id}/rates for the time range you want to update and then resend the payload with the set prices and restrictions.<br>You must have this scope: 'rates.manage'.<br>For fine-grained clients, you must have this permission: 'core.rates.modify'.

put/rateplan/v1/rate-plans/{id}/rates

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/v1/rate-plans/{id}/rates
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: rates.manage, admin

Path parameters

idstring required

The id of the rate plan.

Request body

Example request

{
  "rates": [
    {
      "from": "2026-10-21T17:00:00+02:00",
      "to": "2026-10-22T11:00:00+02:00",
      "price": {
        "amount": 123.5,
        "currency": "EUR"
      },
      "restrictions": {
        "minLengthOfStay": 1,
        "maxLengthOfStay": 30,
        "closed": false,
        "closedOnArrival": true,
        "closedOnDeparture": true
      }
    }
  ]
}

Response

Replace the rates was successful.

Changes

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