Flex Plan Services¶
A Flex Plan Service is the purchased instance of a
Flex Plan on a booking. It follows the same lifecycle
model as other booking services: it is created in an Option state,
confirmed by payment, and may subsequently be expired or (internally)
cancelled.
Supported actions: read and write (create via POST, update via
PATCH).
Restrictions¶
A Flex Plan Service can only be created when all of the following are true:
Stop-sell window. The departure is more than 60 days away (90 days for National Geographic Signature departures). Inside this window the corresponding Flex Plan reports
availability.statusofNOT_BOOKABLE.Late-attach window. Flex can only be attached to an existing booking within 48 hours of the original departure confirmation. Optioned Flex services auto-expire at the end of this window if not confirmed by payment.
Region eligibility. The booking must not be classified as a CEU (Central European (DACH) - Austria, Switzerland, or Germany) booking. CEU classification is based on the passenger’s resident address for Direct bookings, or the agency’s business address for Agency bookings.
One tier per departure service. A departure service can be associated with at most one Flex Plan Service. If travellers on the same departure service require different Flex Tiers, the departure service must first be split into separate services (contact our sales team to arrange this).
Agency eligibility. Flex availability can be disabled for an agency or an entire agency chain. If Flex has been switched off for your agency, Flex products will not be purchasable on your bookings.
Cannot be Cancelled. Once
Confirmed, a Flex Plan Service cannot beCancelledand is 100% non-refundable.
Statuses¶
The status field takes one of the following values:
Status |
Description |
|---|---|
|
The service has been created but not paid for. It is held until
|
|
The service has been paid in full and is active. The Flex purchase price must be paid in full to confirm - Flex cannot be confirmed on a tour deposit alone. |
|
The option lapsed without payment, or was expired explicitly via the API. |
|
The service was cancelled by G Adventures staff. |
Note
A confirmed Flex Plan Service cannot be cancelled through the API.
Cancelled never appears in the status_transitions[] list and is
not an accepted PATCH value. Cancellation of a confirmed Flex
service is a manual, case-by-case action performed by G Adventures
staff - contact our sales team if this is required.
Fields
Name |
Type |
Description |
|---|---|---|
|
String |
|
|
Field |
|
|
String |
The name of this service. |
|
String |
The current status of the service:
Active service status transitions:
|
|
List |
A list of status values to which this service can transition. |
|
String |
The type of this resource. |
|
String |
A brief description of this service type. |
|
Date |
The start date of this service. |
|
Date |
The finish date of this service. |
|
Field |
|
|
String |
|
|
Field |
|
|
Nested Object |
|
|
String |
Legal first name as it appears on a passport. |
|
String |
Legal middle name as it appears on a passport. |
|
String |
Legal last name as it appears on a passport. |
|
String |
The name this person likes to be called if different from their legal name. |
|
String |
The title. Valid values are: Mr, Mrs, Ms, and Miss |
|
Datetime |
The date/time this service was created, in the standard Dates & Times. |
|
Datetime |
The date/time this service had its service status set to Confirmed, in the standard Dates & Times. |
|
Datetime |
The date/time this service had its service status set to Cancelled, in the standard Dates & Times. |
|
Datetime |
The date/time when an Option service status will automatically be set to Expired, in the standard Dates & Times. |
|
Decimal |
The currency-specific purchase price this service was Confirmed at, in the standard Currencies & Prices. The price reflected includes any promotions applied. The price is not locked until the service has its service status set to Confirmed (i.e. the price could change when the service status is on Option). |
|
Decimal |
The currency-specific commission amount that the booking agent will receive for this service, in the standard Currencies & Prices. |
|
Nested Object |
|
|
String |
|
|
Field |
|
|
String |
The name of the promotion used. |
|
String |
A unique code for this promotion. |
|
Decimal |
The currency-specific amount that has been discounted from the purchase_price. Add the discount_amount and purchase_price to see the original non-discounted price. |
|
Integer |
The commission rate for this promotion. |
|
String |
|
|
Field |
The promotions applied to this service |
|
String |
|
|
Field |
|
|
String |
The name of the promotion used. |
|
String |
A unique code for this promotion. |
|
Decimal |
The currency-specific amount that has been discounted from the purchase_price. Add the discount_amount and purchase_price to see the original non-discounted price. |
|
Integer |
The commission rate for this promotion. |
|
String |
|
|
List |
A list of codes that, when present, require special considerations for a booked service. The list of departure service flags related to the current status of a request to hike the Inca Trail, or the option booked for services on these special departures: Service Status Flags
Inca Trail Flags
|
|
Reference Object |
|
|
Field |
|
|
String |
|
|
Field |
|
|
Datetime |
The time when the resource was created, in the standard Dates & Times. |
|
String |
The document type, currently: INVOICE, ATOL_CERTIFICATE, VOUCHER. |
|
String |
The intended audience of this document. Either |
|
Reference Object |
The related booking resource. |
|
String |
The Internet media type. |
|
Reference Object |
The related declined reason resource. |
|
Reference Object |
A reference to the flex plan itself |
|
List |
|
|
Reference Object |
Reference to the concrete (amount-based) cancellation terms resolved for this service at booking time |
|
List |
A list of the flex plan service addons for this service |
Get a Flex Plan Service¶
- GET /flex_plan_services/(string: service_id)/¶
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "12345",
"href": "https://rest.gadventures.com/flex_plan_services/12345/",
"name": "Flex Better",
"status": "Confirmed",
"status_transitions": [],
"type": "flex_plan_services",
"sub_type": "Flex",
"start_date": "2025-03-15",
"finish_date": "2025-03-25",
"customers": [
{
"id": "111",
"href": "https://rest.gadventures.com/customers/111/",
"name": {
"legal_first_name": "John",
"legal_last_name": "Doe"
}
},
{
"id": "222",
"href": "https://rest.gadventures.com/customers/222/",
"name": {
"legal_first_name": "Jane",
"legal_last_name": "Doe"
}
}
],
"date_created": "2024-12-01T10:30:00Z",
"date_confirmed": "2024-12-01T10:30:00Z",
"date_cancelled": null,
"option_expiry_date": null,
"purchase_price": "150.00",
"commission": "0.00",
"flags": [],
"booking": {
"id": "999",
"href": "https://rest.gadventures.com/bookings/999/"
},
"documents": [],
"declined_reason": null,
"product": {
"id": "111",
"href": "https://rest.gadventures.com/flex_plans/111/"
},
"cancellation_terms": {
"id": "5678",
"href": "https://rest.gadventures.com/service_cancellation_terms/5678/"
},
"associated_services": [
{
"id": "5678",
"href": "https://rest.gadventures.com/departure_services/5678/",
"type": "departure_services"
}
],
"flex_plan_addons": [
{
"id": "12345",
"href": "https://rest.gadventures.com/flex_plan_addons/12345/"
},
{
"id": "67890",
"href": "https://rest.gadventures.com/flex_plan_addons/67890/"
}
]
}
Create a Flex Plan Service¶
- POST /flex_plan_services/¶
The referenced departure service must already exist, the booking must not be classified as CEU, and the departure service must not already have a Flex Plan Service attached.
Example request:
POST /flex_plan_services/ HTTP/1.1
Host: rest.gadventures.com
Accept: application/json
Content-Type:application/json
{
"booking": { "id": "999" },
"departure_service": { "id": "5678" },
"product": { "id": "111" }
}
Example response:
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"id": "12345",
"href": "https://rest.gadventures.com/flex_plan_services/12345/",
"name": "Flex Better",
"status": "Option",
"status_transitions": ["Confirmed", "Expired"],
"type": "flex_plan_services",
"sub_type": "Flex",
"start_date": "2025-03-15",
"finish_date": "2025-03-25",
"date_created": "2024-12-01T10:30:00Z",
"date_confirmed": null,
"date_cancelled": null,
"option_expiry_date": "2024-12-03T10:30:00Z",
"purchase_price": "150.00",
"commission": "0.00",
"flags": [],
"booking": {
"id": "999",
"href": "https://rest.gadventures.com/bookings/999/"
},
"documents": [],
"declined_reason": null,
"product": {
"id": "111",
"href": "https://rest.gadventures.com/flex_plans/111/"
},
"cancellation_terms": {
"id": "5678",
"href": "https://rest.gadventures.com/service_cancellation_terms/5678/"
},
"associated_services": [
{
"id": "5678",
"href": "https://rest.gadventures.com/departure_services/5678/",
"type": "departure_services"
}
],
"flex_plan_addons": []
}
The new service is created in the Option status with its
option_expiry_date set.
Note
A Flex Plan Service never affects the booking’s date of first travel - that remains determined by the departure service’s start date.
Confirmation is driven by payment: once the Flex purchase price is paid in
full, the service transitions to Confirmed, date_confirmed is
set, and any bundled ancillary products are ordered and attached as
Flex Plan Service Addons. From the moment the Flex
service covers the departure service, the departure service’s
Service Cancellation Terms resolve to
this plan’s flex terms instead of the departure’s generic terms.
Update a Flex Plan Service¶
- PATCH /flex_plan_services/(string: service_id)/¶
The only permitted update is a status transition.
Example request:
PATCH /flex_plan_services/12345/ HTTP/1.1
Host: rest.gadventures.com
Accept: application/json
Content-Type:application/json
{
"status": "Expired"
}
A successful request returns 200 OK with the updated representation of
the service. Only statuses present in the status_transitions[] list are
accepted; attempting to transition to Cancelled returns an error.
List services on a Booking¶
Flex Plan Services appear alongside other services in the booking services list, each in a summary representation:
- GET /bookings/(string: booking_id)/services/¶
{
"id": "111",
"href": "https://rest.gadventures.com/flex_plan_services/111/",
"name": "Flex Better",
"status": "Confirmed",
"status_transitions": [],
"type": "flex_plan_services",
"sub_type": "Flex",
"start_date": "2026-08-01",
"finish_date": "2026-10-02",
"customers": [
{
"id": "222",
"href": "https://rest.gadventures.com/customers/222/",
"name": {
"legal_first_name": "Flexie",
"legal_middle_name": "McFlex",
"legal_last_name": "Flex",
"common_name": "Flexie",
"title": "Mx"
}
}
]
}
Exercising the Flex terms¶
Exercising a Flex service means cancelling the associated departure service while a confirmed Flex service covers it. When the departure service is cancelled:
finish_dateon the Flex Plan Service is set to the date of exercise.The linked Service Cancellation Terms are applied - refunds, Future Travel Credits (FTCs), and penalties are calculated from the amount-based windows resolved for the departure service, with the window containing the cancellation date determining the
refund_amountandtravel_credit_amount.Any bundled add-on products are cancelled alongside the service.
FTCs issued by Flex carry the booking and travel windows defined for the purchased Flex Tier (12 and 24 months from issuance respectively for G Adventures tiers).
The Flex service itself remains non-refundable regardless of the outcome of the exercise.