Flex Cancellation Terms

The Flex Cancellation Terms resource represents the booking cancellation terms associated with a Flex Plan. The terms are inherited from the Flex Tier referenced by the plan, with each percentage-based window resolved into concrete dates relative to the start date of the departure referenced by the plan.

The identifier is shared with the flex_plans resource: Flex Plan 111 links to Flex Cancellation Terms 111.

This resource is read-only.

Fields

Name

Type

Description

id (read-only)

String

href (read-only)

Field

name (required)

String

The name of this resource.

flex_plan (read-only)

Reference Object

The flex plan for which these flex cancellation terms apply

departure (read-only)

Reference Object

The departure for which these flex cancellation terms apply

booking_company (read-only)

Reference Object

The booking_company associated with these flex cancellation terms

terms_url (required)

Url

The URL where the full terms and conditions for the flex cancellation terms can be found

terms (required)

Nested Object

Description of the flex cancellation terms

  • lifetime_deposit_retention (required)

String

A description of the lifetime deposit policy applicable to these cancellation terms

  • windows (required)

Field

Description of cancellation windows for these cancellation terms

    • effective_from_date (required)

Date

The date relative to the departure start date from which this cancellation window is effective.

    • effective_from_datetime_utc (required)

Datetime

The datetime from which this cancellation window is effective

    • effective_until_date (required)

Date

The date relative to the departure start date until which this cancellation window is effective.

    • effective_until_datetime_utc (required)

Datetime

The datetime until which this cancellation window is effective

    • effective_days (required)

Nested Object

Dates before departure when this cancellation window applies

      • from_start_date (required)

Integer

Number of days before departure where this cancellation window starts being applicable

      • to_start_date (required)

Integer

Number of days before departure where this cancellation window stops being applicable

    • refund_percent (required)

Decimal

The percentage amount that is refunded when this cancellation window applies

    • travel_credit_percent (required)

Decimal

The percentage amount that is credited as a travel credit when this cancellation window applies

Get Flex Cancellation Terms

GET /flex_cancellation_terms/(string: flex_plan_id)/