---
title: "Get cancellation policies by rates"
method: POST
path: "/api/connector/v1/cancellationPolicies/getByRates"
tags: ["Cancellation policies"]
---

# Get cancellation policies by rates

`POST /api/connector/v1/cancellationPolicies/getByRates`

Gets cancellation policies for enterprise grouped by rate for granular cancellation policies flow. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- CancellationPolicyByRateParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `RateIds` string[], required — Unique identifiers of the `Rate`.
  - `ReservationStartUtc` string, date-time, required — Start of the reservation interval in UTC timezone in ISO 8601 format.
  - `ReservationEndUtc` string, date-time, required — End of the reservation interval in UTC timezone in ISO 8601 format.

## Response `200`

OK

- CancellationPolicyByRateResult
  - `CancellationPolicies` CancellationPolicyByRate[], required — List of cancellation policies data grouped by rate.
    - `RateId` string, uuid, required — Unique identifier of the `Rate`.
    - `Policies` CancellationPolicyData[], required — Collection of cancellation policy data.
      - `Applicability` 'Creation' | 'Start' | 'StartDate', required — Applicability mode of the cancellation policy. Creation Start StartDate
      - `FeeExtents` CancellationFeeExtentEnum[], required — Extent for the cancellation fee, i.e. what should be in scope for the automatic payment.
      - `ApplicabilityOffset` string, required — Offset for order start (assuming Applicability is set to Start) from which the fee is applied in ISO 8601 duration format.
      - `FeeMaximumTimeUnits` integer, nullable — Maximum number of time units the cancellation fee is applicable to.
      - `AbsoluteFee` CurrencyValue, required — Absolute value of the fee.
        - `Currency` string, currency, required — ISO-4217 code of the `Currency`.
        - `Value` number, double, required — Amount in the currency.
      - `RelativeFee` number, double, required — Relative value of the fee, as a percentage of the reservation price.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
- `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/versions/81933a8ff730/schema)