Sign in
flight-hotel-offers

Get Flight Hotel Obligation

get/flight-hotel-obligations/{obligation_id}

Path parameters

obligation_idstring uuid required

Response

Successful Response

idstring uuid required
user_idstring uuid required
flight_booking_idstring required
payment_intent_idstring required
accepted_terms_versionstring required
accepted_terms_textstring required
customer_deadlinestring date-time required
final_cutoffstring date-time required
flight_booking_session_idstring uuid required
status'waiting_hotel' | 'capture_pending' | 'satisfied' | 'expiry_checking' | 'expiring' | 'expired' | 'needs_review' | 'cancelled' required
accepted_atstring date-time required
window_started_atstring date-time required
qualifying_hotel_purchase_idstring uuid nullable required
hotel_completed_atstring date-time nullable required
captured_atstring date-time nullable required
expiry_started_atstring date-time nullable required
hold_released_atstring date-time nullable required
expired_atstring date-time nullable required
payment_statusstring nullable required

Persisted flight payment status; not a live Stripe lookup.

flight_cancellation_status'not_requested' | 'pending' | 'cancelled' | 'failed' required
flight_cancelled_atstring date-time nullable required
card_hold_centsinteger
credit_applied_centsinteger
credit_status'none' | 'applied' | 'restore_pending' | 'restored'
credit_restored_atstring date-time nullable
ancillary_amount_centsinteger
ancillary_status'none' | 'held' | 'fulfilled' | 'refund_pending' | 'refunded' | 'released'
reminder_sent_atstring date-time nullable
sms_reminder_sent_atstring date-time nullable

Example response

{
  "hotel_search_context": {
    "guests": {
      "rooms": [
        {
          "adults": 2,
          "children": [
            {
              "age": 5
            }
          ]
        }
      ]
    }
  }
}

Changes

Changed in 3 of the 22 revisions of this API.110

  • ff95d5d338e41See the full diff
    • ●

      added the new cancelled enum value to the response property for the response status

      response-property-enum-value-added

  • c1e649dcf8e09See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 5d2121d26b961See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 22 revisions, 1 has no diff computed.