APapaleo
CancellationPolicy

Get a specific cancellation policy.

Get a specific cancellation policy.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.cancellation_policies.read'.

get/rateplan/v1/cancellation-policies/{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/v1/cancellation-policies/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Path parameters

idstring required

The id of the cancellation policy.

Query parameters

languagesstring[]

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

Response

Success.

idstring required

The cancellation policy id

codestring required

The code for the policy

nameobject required

The name for the cancellation policy

descriptionobject required

The description for the cancellation policy

propertyIdstring required

The id of the property where the cancellation policy was created

reference'PriorToArrival' | 'AfterBooking' required

The due date for the cancellation policy will be calculated based on this reference point, and the defined time period.

Examples:

  • 1 day and 12 hours prior to arrival

  • 0 prior to arrival (meaning, cancellations are always free)

  • 24 hours after booking

  • 0 after booking (meaning, cancellations ar never free)

Example response

{
  "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"
      ]
    }
  }
}

Changes

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