Cancellation policies

Get all cancellation policies

Restricted!

This operation is currently in beta-test and as such it is subject to change. Returns all cancellation policies, filtered by services, rate groups and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/cancellationPolicies/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "ServiceIds": [
    "e654f217-d1b5-46be-a820-e93ba568dfac"
  ],
  "CancellationPolicyIds": [
    "fe795f96-0b64-445b-89ed-c032563f2bac"
  ],
  "RateGroupIds": [
    "deb9444e-6897-4f2a-86b4-aff100c2896e"
  ],
  "UpdatedUtc": {
    "StartUtc": "2023-04-27T11:48:57Z",
    "EndUtc": "2023-04-27T11:48:57Z"
  },
  "Limitation": {
    "Count": 10
  }
}

Property	Type	Contract	Description
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.
EnterpriseIds	array of string	optional, max 1000 items	Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
ServiceIds	array of string	required, max 100 items	Unique identifiers of the Service.
CancellationPolicyIds	array of string	optional, max 1000 items	Unique identifiers of the Cancellation Policy. Required if no other filter is provided.
RateGroupIds	array of string	optional, max 1000 items	Unique identifiers of the Rate group. Required if no other filter is provided.
UpdatedUtc	Time interval	optional, max length 3 months	Interval in which the Cancellation Policy was updated. Required if no other filter is provided.
ActivityStates	array of Activity state	optional	Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.
Limitation	Limitation	required	Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "CancellationPolicies": [
    {
      "Id": "769fc613-838f-41a7-ac2a-aff100c3189f",
      "RateGroupId": "deb9444e-6897-4f2a-86b4-aff100c2896e",
      "CreatedUtc": "2023-04-27T11:48:57Z",
      "UpdatedUtc": "2023-04-27T11:48:57Z",
      "Applicability": "Creation",
      "FeeExtent": [
        "TimeUnits",
        "Products"
      ],
      "ApplicabilityOffset": "0M0D0:0:0.0",
      "FeeMaximumTimeUnits": 0,
      "AbsoluteFee": {
        "Currency": "EUR",
        "Value": 15
      },
      "RelativeFee": 0
    }
  ],
  "Cursor": "769fc613-838f-41a7-ac2a-aff100c3189f"
}

Property	Type	Contract	Description
CancellationPolicies	array of Cancellation Policy	required, max 1000 items	The filtered cancellation policies.
Cursor	string	optional	Unique identifier of the last and hence oldest cancellation policy returned. This can be used in Limitation in a subsequent request to fetch the next batch of older cancellation policies.

Cancellation Policy

Property	Type	Contract	Description
Id	string	required	Unique identifier of the cancellation policy.
RateGroupId	string	required	Unique identifier of the rate group the cancellation policy belongs to.
CreatedUtc	string	required	Date and time of the cancellation policy creation in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Date and time of the cancellation policy update in UTC timezone in ISO 8601 format.
Applicability	Cancellation Policy Applicability	required	Applicability mode of the cancellation policy.
FeeExtent	array of Cancellation Fee Extent	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.
FeeMaximumTimeUnits	integer	optional	Maximum number of time units the cancellation fee is applicable to.
AbsoluteFee	Currency value (ver 2023-02-02)	required	Absolute value of the fee.
RelativeFee	number	required	Relative value of the fee, as a percentage of the reservation price.
IsActive	boolean	required	Whether the cancellation policy is still active.

Cancellation Policy Applicability

• Creation

• Start

• StartDate

Cancellation Fee Extent

• TimeUnits

• Products

Get cancellation policies by reservations

Restricted!

This operation is currently in beta-test and as such it is subject to change.

Gets cancellation policies for enterprise grouped by reservation for granular cancellation policies flow. This operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/cancellationPolicies/getByReservations

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ReservationIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ]
}

Property	Type	Contract	Description
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.
ReservationIds	array of string	required, max 100 items	Unique identifiers of the Reservation.

Response

{
  "CancellationPolicies": [
    {
      "ReservationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Policies": [
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P10DT20H30M",
          "FeeMaximumTimeUnits": 1,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 20
          },
          "RelativeFee": 0.1
        }
      ]
    },
    {
      "ReservationId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
      "Policies": [
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P5DT10H30M",
          "FeeMaximumTimeUnits": 2,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 15
          },
          "RelativeFee": 0.4
        },
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P10DT10H30M",
          "FeeMaximumTimeUnits": 2,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 15
          },
          "RelativeFee": 0.2
        }
      ]
    }
  ]
}

Property	Type	Contract	Description
CancellationPolicies	array of Cancellation policy data grouped by reservation	required, max 1300 items	List of cancellation policies data grouped by reservation.

Cancellation policy data grouped by reservation

Property	Type	Contract	Description
ReservationId	string	required	Unique identifier of the reservation.
Policies	array of Cancellation policy data	required	Collection of cancellation policy data.

Cancellation policy data

Property	Type	Contract	Description
Applicability	Cancellation Policy Applicability	required	Applicability mode of the cancellation policy.
FeeExtents	array of Cancellation Fee Extent	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	optional	Maximum number of time units the cancellation fee is applicable to.
AbsoluteFee	Currency value (ver 2023-02-02)	required	Absolute value of the fee.
RelativeFee	number	required	Relative value of the fee, as a percentage of the reservation price.

Cancellation Policy Applicability

• Creation

• Start

• StartDate

Cancellation Fee Extent

• Nothing

• TimeUnits

• Products

• Everything

Get cancellation policies by rates

Restricted!

This operation is currently in beta-test and as such it is subject to change.

Gets cancellation policies for enterprise grouped by rate for granular cancellation policies flow. This operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/cancellationPolicies/getByRates

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "RateIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ]
}

Property	Type	Contract	Description
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	array of string	required, max 100 items	Unique identifiers of the Rate.
ReservationStartUtc	string	required	Start of the reservation interval in UTC timezone in ISO 8601 format.
ReservationEndUtc	string	required	End of the reservation interval in UTC timezone in ISO 8601 format.

Response

{
  "CancellationPolicies": [
    {
      "RateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Policies": [
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P10DT20H30M",
          "FeeMaximumTimeUnits": 1,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 20
          },
          "RelativeFee": 0.1
        }
      ]
    },
    {
      "RateId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
      "Policies": [
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P5DT10H30M",
          "FeeMaximumTimeUnits": 2,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 15
          },
          "RelativeFee": 0.4
        },
        {
          "Applicability": "Start",
          "FeeExtents": [
            "TimeUnits",
            "Products"
          ],
          "ApplicabilityOffset": "P10DT10H30M",
          "FeeMaximumTimeUnits": 2,
          "AbsoluteFee": {
            "Currency": "EUR",
            "Value": 15
          },
          "RelativeFee": 0.2
        }
      ]
    }
  ]
}

Property	Type	Contract	Description
CancellationPolicies	array of Cancellation policy data grouped by rate	required, max 1300 items	List of cancellation policies data grouped by rate.

Cancellation policy data grouped by rate

Property	Type	Contract	Description
RateId	string	required	Unique identifier of the Rate.
Policies	array of Cancellation policy data	required	Collection of cancellation policy data.