Cancellation policies
Get all cancellation policies (ver 2026-07-31)
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Returns the current versions of cancellation policies within the enterprise scope in the same shape as the add, update operations, including policies that are not currently assigned to any rate or reservation. Historical versions produced by fee-affecting updates are not returned. Optionally filtered by CancellationPolicyIds, UpdatedUtc, and ActivityStates; when no filter is provided all current cancellation policies within the enterprise scope are returned. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/cancellationPolicies/getAll/2026-07-31
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CancellationPolicyIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"UpdatedUtc": {
"StartUtc": "2026-07-01T00:00:00Z",
"EndUtc": "2026-07-31T00:00:00Z"
},
"ActivityStates": [
"Active"
],
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"Limitation": {
"Count": 100
}
}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.
CancellationPolicyIds
array of string
optional, max 100 items
Unique identifiers of the requested cancellation policies. If not specified, all current cancellation policy versions within the enterprise scope are returned.
UpdatedUtc
optional, max length 3 months
Interval in which the cancellation policy was updated.
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
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
CancellationPolicies
required, max 1000 items
The requested cancellation policies.
Cursor
string
optional
Opaque pagination cursor which can be used in Limitation to fetch further cancellation policies.
Cancellation policy modification data
Id
string
required
Unique identifier of the cancellation policy.
EnterpriseId
string
required
Unique identifier of the enterprise the cancellation policy belongs to.
CreatedUtc
string
required
Creation date and time of the cancellation policy in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the cancellation policy in UTC timezone in ISO 8601 format.
IsActive
boolean
required
Whether the cancellation policy is still active.
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 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.
RelativeFee
number
required
Relative value of the fee, as a percentage of the reservation price.
Name
string
optional
Name of the cancellation policy.
ExternalIdentifier
string
optional
Identifier of the cancellation policy from an external system, unique within the enterprise, that can be used to reference the policy from your own system.
IsPortfolioManaged
boolean
required
Whether the cancellation policy is managed by the portfolio. Policies managed by the portfolio cannot be updated or deleted through this resource.
Cancellation Policy Applicability
CreationStartStartDate
Cancellation Fee Extent
NothingTimeUnitsProductsEverything
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
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.
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
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
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
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
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
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.
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
CreationStartStartDate
Cancellation Fee Extent
TimeUnitsProducts
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
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
required, max 1300 items
List of cancellation policies data grouped by reservation.
Cancellation policy data grouped by reservation
ReservationId
string
required
Unique identifier of the reservation.
Cancellation policy data
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.
RelativeFee
number
required
Relative value of the fee, as a percentage of the reservation price.
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
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
required, max 1300 items
List of cancellation policies data grouped by rate.
Cancellation policy data grouped by rate
RateId
string
required
Unique identifier of the Rate.
Add cancellation policies
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Adds one or more cancellation policies to the specified enterprise. This operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/cancellationPolicies/add
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.
EnterpriseId
string
optional
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
CancellationPolicies
array of Cancellation policy add parameters
required, max 100 items
Parameters of the new cancellation policies to be created.
Cancellation policy add parameters
Applicability
required
Applicability mode of the cancellation policy.
FeeExtents
array of Cancellation Fee Extent
required, max 10 items
Extent for the cancellation fee, i.e. what should be in scope for the automatic payment.
ApplicabilityOffset
string
optional
Offset from which the fee is applied in ISO 8601 duration format. Defaults to zero when not provided.
FeeMaximumTimeUnits
integer
optional
Maximum number of time units the cancellation fee is applicable to.
RelativeFee
number
required
Relative value of the fee, as a percentage of the reservation price. Must be between 0 and 1. Defaults to 0.
Name
string
optional, max length 255 characters
Name of the cancellation policy.
ExternalIdentifier
string
optional, max length 255 characters
Identifier of the cancellation policy from an external system, unique within the enterprise. Use it to reference the policy from your own system. Adding another policy with the same external identifier in the same enterprise is rejected. Note that add always creates a new policy; it never updates an existing one matched by this identifier.
Response
CancellationPolicies
required, max 100 items
Cancellation policies affected by the operation.
Update cancellation policies
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Updates one or more existing cancellation policies. Only the fields that are set are updated. Cancellation policies managed by portfolio cannot be updated. This operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/cancellationPolicies/update
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.
EnterpriseId
string
optional
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
CancellationPolicyUpdates
required, max 100 items
Details of the cancellation policies to be updated.
Cancellation policy update parameters
CancellationPolicyId
string
required
Unique identifier of the cancellation policy to be updated.
Applicability
optional
Applicability mode of the cancellation policy (or null if it should not be updated).
FeeExtents
optional
Extent for the cancellation fee, up to 10 values (or null if it should not be updated).
ApplicabilityOffset
optional
Offset from which the fee is applied in ISO 8601 duration format. Set the inner value to null to reset it to zero (or null if it should not be updated).
FeeMaximumTimeUnits
optional
Maximum number of time units the cancellation fee is applicable to. Set the inner value to null to clear it (or null if it should not be updated).
AbsoluteFee
optional
Absolute value of the fee (or null if it should not be updated).
RelativeFee
optional
Relative value of the fee, as a percentage of the reservation price. Must be between 0 and 1 (or null if it should not be updated).
Name
optional
Name of the cancellation policy. Set the inner value to null to clear it (or null if it should not be updated).
ExternalIdentifier
optional
Identifier of the cancellation policy from an external system, unique within the enterprise, used to reference the policy from your own system. Set the inner value to null to clear it (or null if it should not be updated).
Cancellation Policy Applicability update value
Cancellation Fee Extent array update value
Currency value (ver 2023-02-02) update value
Response
CancellationPolicies
required, max 100 items
Cancellation policies affected by the operation.
Delete cancellation policies
Restricted!
This operation is currently in beta-test and as such it is subject to change.
Deletes the specified cancellation policies. Cancellation policies managed by portfolio cannot be deleted. This operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/cancellationPolicies/delete
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.
EnterpriseId
string
optional
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
CancellationPolicyIds
array of string
required, max 100 items
Unique identifiers of the cancellation policies to be deleted.
Response
Last updated
Was this helpful?