---
title: "Get all cancellation policies."
method: GET
path: "/rateplan/v0-nsfw/cancellation-policies"
tags: ["CancellationPolicy"]
---

# Get all cancellation policies.

`GET /rateplan/v0-nsfw/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/v0-nsfw/cancellation-policies`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `settings.read`, `setup.read`, `setup.manage`, `admin`

Get the list of cancellation policies.<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'.

## Query parameters

- `propertyId` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success.

- CancellationPolicyListModel
  - `cancellationPolicies` CancellationPolicyItemModel[], required: List of cancellation policies
    - `id` string, required: Id
    - `name` string, required: Name
    - `code` string, required: The code for the cancellation policy
    - `description` string, required: Description
    - `propertyId` string, required: The id of the property where the cancellation policy was created
    - `periodFromReference` PeriodModel, required
      - `hours` integer, nullable: The number of hours within the period
      - `days` integer, nullable: The number of days within the period
      - `months` integer, nullable: The number of months within the period
    - `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)
    - `fee` FeeDetailsModel, required
      - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required: VAT that applies for the fee
      - `fixedValue` MonetaryValueModel
        - `amount` number, double, required
        - `currency` string, required
      - `percentValue` PercentValueModel
        - `percent` integer, required: Percent to take from the base. Must be between 0 and 100.
        - `limit` integer, nullable: If set, limits the calculation base to the specified number of time slices, starting from the beginning. If not set, the entire stay will be used as a base.
        - `includeServiceIds` string[], nullable: Services included in the calculation base. If none are set, only charges for the unit will be used. The services are only included, if they are part of the rate plan. Extra services are ignored.
  - `count` integer, required: Total count of items

## Other responses

- `204`: No cancellation policies could be found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/revisions/97dec9512a17?raw)