APapaleo
CancellationPolicy

Create a cancellation policy.

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

post/rateplan/v1/cancellation-policies

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
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.manage, setup.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

The code for the cancellation policy, used to assemble its id

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 will be created

reference'PriorToArrival' | 'AfterBooking' required

The due date for the cancellation policy will be calculated based on this reference point

Example request

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

Response

Cancellation policy successfully created.

idstring required

The cancellation policy ID

Example response

{
  "id": "MUC-FLE"
}

Changes

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