RatePlanSchedules

Get the schedules attached to a rate plan.

Returns the rate plan's default cancellation policy and every attached schedule, including the period and the applied policy terms.<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}/schedules

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}/schedules
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)

Response

The rate plan default and attached schedules.

ratePlanIdstring required

The rate plan id

Example response

{
  "ratePlanId": "MUC-BAR",
  "default": {
    "cancellationPolicyId": "MUC-FLE",
    "cancellationPolicy": {
      "id": "MUC-FLE",
      "code": "FLE",
      "name": {
        "en": "Flexible",
        "de": "Flexibel"
      },
      "description": {
        "en": "Free cancellation until 36 hours before arrival.",
        "de": "Kostenfreies Storno bis 36 Stunden vor Ankunft."
      },
      "propertyId": "MUC",
      "periodFromReference": {
        "hours": 12,
        "days": 1
      },
      "reference": "PriorToArrival",
      "fee": {
        "vatType": "Reduced",
        "percentValue": {
          "percent": 100,
          "limit": 1,
          "includeServiceIds": [
            "MUC-BRK"
          ]
        }
      }
    }
  },
  "schedules": [
    {
      "id": "MUC-WIESN2026",
      "code": "WIESN2026",
      "name": "Oktoberfest 2026",
      "validFrom": "2026-09-20",
      "validTo": "2026-10-05",
      "cancellationPolicy": {
        "id": "MUC-STR",
        "code": "STR",
        "name": {
          "en": "Flexible",
          "de": "Flexibel"
        },
        "description": {
          "en": "Free cancellation until 36 hours before arrival.",
          "de": "Kostenfreies Storno bis 36 Stunden vor Ankunft."
        },
        "propertyId": "MUC",
        "periodFromReference": {
          "hours": 12,
          "days": 1
        },
        "reference": "PriorToArrival",
        "fee": {
          "vatType": "Reduced",
          "percentValue": {
            "percent": 100,
            "limit": 1,
            "includeServiceIds": [
              "MUC-BRK"
            ]
          }
        }
      }
    }
  ]
}

Changes

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