> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Order Cancellation

> Retrieve an order cancellation quote



## OpenAPI

````yaml openapi/zh/duffel-flights.json GET /apis/v1/duffel/flights/order-cancellations/{id}
openapi: 3.1.0
info:
  description: ''
  title: Duffel Flights
  version: '1'
  x-aisa-capabilities:
    idempotency: Idempotency-Key
    max_price: X-AISA-Max-Price-USD
    quote:
      header: X-AISA-Cost-Mode
      value: quote
  x-aisa-configured-paths:
    - /apis/v1/duffel/flights/offer-requests/create
    - /apis/v1/duffel/flights/offer-requests/list
    - /apis/v1/duffel/flights/offer-requests/{id}
    - /apis/v1/duffel/flights/offers/list
    - /apis/v1/duffel/flights/offers/{id}
    - /apis/v1/duffel/flights/order-cancellations/create
    - /apis/v1/duffel/flights/order-cancellations/{id}
    - /apis/v1/duffel/flights/order-cancellations/{id}/confirm
    - /apis/v1/duffel/flights/order-change-requests/create
    - /apis/v1/duffel/flights/order-change-requests/{id}
    - /apis/v1/duffel/flights/order-changes/create
    - /apis/v1/duffel/flights/orders/create
    - /apis/v1/duffel/flights/orders/hold-create
    - /apis/v1/duffel/flights/seat-maps
  x-aisa-document:
    facts_hash: f5da5a328e1cec5e66cbcd1109d12fa71687c2c4e8bd1da8db603ed7bccd6637
    generator_version: '2'
    protocol_version: '1'
    schema_version: '1'
    composer_version: '13'
    response_pending:
      - operation_id: post_duffel_offer_requests_create
        path: /apis/v1/duffel/flights/offer-requests/create
        method: POST
        statuses:
          - '200'
        reason: public success response has no authoritative payload declaration
      - operation_id: get_duffel_offer_request
        path: /apis/v1/duffel/flights/offer-requests/{id}
        method: GET
        statuses:
          - '200'
        reason: public success response has no authoritative payload declaration
    document_hash: sha256:bede2cc04d9a6a5b3f07d39c9a84e32a4c2c99be12c3c7e14b9df2ff3c3a3d8a
  x-aisa-plans:
    builder: 1
    display_plan: payg
    payg: 1
    similarweb_payg: 1
    team: 1
    version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-provider: duffel-flights
  x-aisa-catalogs:
    duffel-flights:
      title: Duffel Flights
      description: ''
      x-aisa-document:
        facts_hash: f5da5a328e1cec5e66cbcd1109d12fa71687c2c4e8bd1da8db603ed7bccd6637
        generator_version: '2'
        protocol_version: '1'
        schema_version: '1'
      x-aisa-plans:
        builder: 1
        display_plan: payg
        payg: 1
        similarweb_payg: 1
        team: 1
        version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
      x-aisa-capabilities:
        idempotency: Idempotency-Key
        max_price: X-AISA-Max-Price-USD
        quote:
          header: X-AISA-Cost-Mode
          value: quote
servers:
  - url: https://api.aisa.one
security:
  - bearerAuth: []
paths:
  /apis/v1/duffel/flights/order-cancellations/{id}:
    get:
      tags:
        - duffel
      summary: Get Order Cancellation
      description: Retrieve an order cancellation quote
      operationId: get_duffel_order_cancellation
      responses:
        default:
          content:
            application/json:
              schema: {}
          description: >-
            Error response; upstream passthrough responses may use provider
            formats
        2XX:
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    additionalProperties: false
                    description: >-
                      An order cancellation is used to cancel an order with an
                      airline
                    properties:
                      airline_credits:
                        description: >
                          For unconfirmed cancellations, it lists airilne
                          credits that would be generated if the cancellation is
                          confirmed.

                          For confirmed cancellations, it lists airline credits
                          that were generated when this cancellation was
                          confirmed.
                        items:
                          oneOf:
                            - additionalProperties: false
                              description: >-
                                An airline credit quote represents the airline
                                credit that would be issued by the airline if
                                the order is cancelled.
                              properties:
                                amount:
                                  description: >
                                    The monetary value associated with this
                                    airline credit
                                  example: '90.80'
                                  type: string
                                amount_currency:
                                  description: >
                                    The currency in which this airline credit is
                                    issued, as an [ISO
                                    4217](https://en.wikipedia.org/wiki/ISO_4217)
                                    currency code
                                  example: GBP
                                  type: string
                                code:
                                  description: >
                                    The code which identifies the airline credit
                                    to the airline and will be used to redeem
                                    the airline credit
                                  example: '1234567890123'
                                  type:
                                    - string
                                    - 'null'
                                credit_amount:
                                  deprecated: true
                                  description: >
                                    The monetary value associated with this
                                    airline credit
                                  example: '90.80'
                                  type: string
                                credit_code:
                                  deprecated: true
                                  description: >
                                    The code which identifies the airline credit
                                    to the airline and will be used to redeem
                                    the airline credit
                                  example: '1234567890123'
                                  type:
                                    - string
                                    - 'null'
                                credit_currency:
                                  deprecated: true
                                  description: >
                                    The currency in which this airline credit is
                                    issued, as an [ISO
                                    4217](https://en.wikipedia.org/wiki/ISO_4217)
                                    currency code
                                  example: GBP
                                  type: string
                                credit_name:
                                  deprecated: true
                                  description: >
                                    The human-readable name used by the airline
                                    to categorize the type of credit being
                                    offered. This name should help when trying
                                    to understand the airline's conditions of
                                    use which apply to this credit.
                                  example: Duffel Travel Credit
                                  type: string
                                id:
                                  description: >
                                    Duffel's unique identifier for the airline
                                    credit quote
                                  example: act_00009qzZWzjDipIkqpaUAj
                                  type: string
                                issued_on:
                                  description: >
                                    The date the credit was issued.

                                    It is important to note that this date might
                                    not be the same as the date of cancellation.
                                    Often airlines associate credits with
                                    tickets, in which case the date of issue is
                                    considered to be the date the ticket was
                                    originally issued.

                                    Airline credits may have expiration dates
                                    which are based on the date of issue.
                                    Airlines don't always reliably disclose the
                                    expiration date in their APIs at the time of
                                    cancellation, so we are unable to return
                                    this information on airline credits. To get
                                    the latest info on expiration dates for
                                    airline credits we recommend checking
                                    directly with the airlines to determine the
                                    specific conditions of use for the credit.
                                  example: '2023-02-24'
                                  format: date
                                  type: string
                                passenger_id:
                                  description: >
                                    Duffel's unique identifier for the passenger
                                    on the order that the credit is associated
                                    with
                                  example: pas_00009hj8USM7Ncg31cBCLL
                                  type: string
                                type:
                                  description: >
                                    The type of airline credit that would be
                                    issued if the cancellation is confirmed. Use
                                    this to distinguish between credits that the
                                    airline will issue against the original
                                    e-ticket (`eticket`) and credits issued as a
                                    separate MCO/EMD document (`mco`, `emd`).
                                  enum:
                                    - eticket
                                    - mco
                                    - emd
                                  example: eticket
                                  type: string
                              required:
                                - id
                                - amount
                                - code
                                - amount_currency
                                - issued_on
                                - passenger_id
                                - type
                              title: Airline Credit Quote
                              type: object
                            - additionalProperties: false
                              description: >-
                                An airline credit represents credit issued by an
                                airline for a canceled or disrupted flight.
                              properties:
                                airline_iata_code:
                                  description: >-
                                    The two-character IATA code for the airline
                                    that issued this credit
                                  example: AA
                                  type: string
                                amount:
                                  description: Value of this airline credit
                                  example: '30.20'
                                  type: string
                                amount_currency:
                                  description: >
                                    The currency of the `amount`, as an [ISO
                                    4217](https://en.wikipedia.org/wiki/ISO_4217)
                                    currency code.
                                  example: GBP
                                  format: ISO 4217
                                  type:
                                    - string
                                    - 'null'
                                code:
                                  description: Credit identifier provided by the airline
                                  example: '12345678'
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  description: >-
                                    The [ISO
                                    8601](https://en.wikipedia.org/wiki/ISO_8601)
                                    datetime at which the airline credit was
                                    created.
                                  example: '2020-04-11T15:48:11.642Z'
                                  format: date-time
                                  type: string
                                credit_amount:
                                  deprecated: true
                                  description: >
                                    The monetary value associated with this
                                    airline credit
                                  example: '90.80'
                                  type: string
                                credit_code:
                                  deprecated: true
                                  description: >
                                    The code which identifies the airline credit
                                    to the airline and will be used to redeem
                                    the airline credit
                                  example: '1234567890123'
                                  type:
                                    - string
                                    - 'null'
                                credit_currency:
                                  deprecated: true
                                  description: >
                                    The currency in which this airline credit is
                                    issued, as an [ISO
                                    4217](https://en.wikipedia.org/wiki/ISO_4217)
                                    currency code
                                  example: GBP
                                  type: string
                                credit_name:
                                  deprecated: true
                                  description: >
                                    The common name given to this airline
                                    credit.
                                  example: Future Flight Credit
                                  type: string
                                expires_at:
                                  description: >-
                                    The [ISO
                                    8601](https://en.wikipedia.org/wiki/ISO_8601)
                                    datetime at which the airline credit expires
                                    and will no longer be eligible for payment.
                                  example: '2020-04-11T15:48:11.642Z'
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                family_name:
                                  description: >
                                    The family name of the passenger associated
                                    with this airline credit.
                                  example: Doe
                                  type: string
                                given_name:
                                  description: >
                                    The given name of the passenger associated
                                    with this airline credit.
                                  example: John
                                  type:
                                    - string
                                    - 'null'
                                id:
                                  description: Duffel's unique identifier for the resource
                                  example: acd_00009UhD4ongolulWd91Ky
                                  type: string
                                invalidated_at:
                                  description: >-
                                    The [ISO
                                    8601](https://en.wikipedia.org/wiki/ISO_8601)
                                    datetime at which the airline credit was
                                    invalidated. Invalidated credits are not
                                    eligible for payment.
                                  example: '2020-04-11T15:48:11.642Z'
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                issued_on:
                                  description: >-
                                    The [ISO
                                    8601](https://en.wikipedia.org/wiki/ISO_8601)
                                    datetime at which the airline credit was
                                    issued by the airline.
                                  example: '2020-04-11'
                                  format: date
                                  type: string
                                live_mode:
                                  description: >-
                                    Whether the payment was created in live
                                    mode. This field will be set to `true` if
                                    the payment was created in live mode, or
                                    `false` if it was created in test mode.
                                  example: false
                                  type: boolean
                                order_id:
                                  description: >
                                    Duffel's unique identifier for the order
                                    that the credit is associated with
                                  example: ord_00009hj8USM7Ncg31cBCLL
                                  type:
                                    - string
                                    - 'null'
                                passenger_id:
                                  description: >
                                    Duffel's unique identifier for the passenger
                                    on the order that the credit is associated
                                    with
                                  example: pas_00009hj8USM7Ncg31cBCLL
                                  type:
                                    - string
                                    - 'null'
                                penalty_amount:
                                  description: >-
                                    The penalty that will be incurred when
                                    paying with this airline credit
                                  example: '10.20'
                                  type:
                                    - string
                                    - 'null'
                                penalty_currency:
                                  description: >
                                    The currency of the penalty amount, as an
                                    [ISO
                                    4217](https://en.wikipedia.org/wiki/ISO_4217)
                                    currency code.
                                  example: GBP
                                  format: ISO 4217
                                  type:
                                    - string
                                    - 'null'
                                spent_at:
                                  description: >-
                                    The [ISO
                                    8601](https://en.wikipedia.org/wiki/ISO_8601)
                                    datetime at which the airline credit was
                                    spent. Spent credits are not eligible for
                                    payment.
                                  example: '2020-04-11T15:48:11.642Z'
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                type:
                                  description: Type of the airline credit
                                  enum:
                                    - eticket
                                    - mco
                                    - emd
                                  example: eticket
                                  type: string
                                user_id:
                                  description: >
                                    Duffel's unique identifier for the customer
                                    user that the credit is associated with
                                  example: icu_00009hj8USM7Ncg31cBCLL
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                                - amount
                                - amount_currency
                                - created_at
                                - issued_on
                                - live_mode
                                - given_name
                                - family_name
                                - type
                                - airline_iata_code
                                - expires_at
                              title: Airline Credit
                              type: object
                        type: array
                      confirmed_at:
                        description: >-
                          The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
                          datetime that indicates when the order cancellation
                          was confirmed
                        example: '2020-01-17T11:51:43.114803Z'
                        format: date-time
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: >-
                          The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
                          datetime at which the order cancellation was created
                        example: '2020-04-11T15:48:11.642Z'
                        format: date-time
                        type: string
                      expires_at:
                        description: >-
                          The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
                          datetime by which this cancellation must be confirmed
                        example: '2020-01-17T10:42:14Z'
                        format: date-time
                        type:
                          - string
                          - 'null'
                      id:
                        description: Duffel's unique identifier for the resource
                        example: ore_00009qzZWzjDipIkqpaUAj
                        type: string
                      live_mode:
                        description: >-
                          Whether the order cancellation was created in live
                          mode. This field will be set to `true` if the order
                          cancellation was created in live mode, or `false` if
                          it was created in test mode.
                        example: false
                        type: boolean
                      order_id:
                        description: Duffel's unique identifier for the resource
                        example: xxx_00009hthhsUZ8W4LxQgkjo
                        type: string
                      refund_amount:
                        description: >
                          The total value that will be returned to the customer
                          if the order is cancelled, determined according to the
                          fare conditions. When the original order was paid with
                          a mix of cash and airline credit and the cancellation
                          is a void, this is the grand total across both the
                          cash refunded to the original payment method and any
                          re-issued
                          [`airline_credits`](#tag/Order-Cancellations). This
                          may be `0.00` if the fare is non-refundable. It will
                          include the refund amount of the flights and the
                          services booked. This may be null in cases where the
                          refund amount is unknown. This only applies in cases
                          where we are unable to get a refund quote from the
                          carrier.
                        example: '90.80'
                        type:
                          - string
                          - 'null'
                      refund_currency:
                        description: >
                          The currency of the `refund_amount`, as an [ISO
                          4217](https://en.wikipedia.org/wiki/ISO_4217) currency
                          code.

                          It will match your organisation's billing currency
                          unless you’re using Duffel as an accredited IATA
                          agent, in which case it will be in the currency
                          provided by the airline (which will usually be based
                          on the country where your IATA agency is registered).

                          For `hold` orders that are awaiting payment, the
                          refund amount will always be 0.00.
                        example: GBP
                        format: ISO 4217
                        type:
                          - string
                          - 'null'
                      refund_to:
                        description: >
                          Where the refund, once confirmed, will be sent.

                          `awaiting_payment` is for pay later orders where no
                          payment has been made yet.
                        enum:
                          - arc_bsp_cash
                          - balance
                          - card
                          - voucher
                          - awaiting_payment
                          - airline_credits
                          - original_form_of_payment
                        example: arc_bsp_cash
                        type: string
                    required:
                      - id
                      - order_id
                      - live_mode
                      - expires_at
                      - refund_amount
                      - refund_currency
                      - refund_to
                      - confirmed_at
                      - created_at
                      - airline_credits
                    title: Order Cancellation
                    type: object
                  meta:
                    type: object
                    properties:
                      limit:
                        type: number
                      before:
                        type: string
                      after:
                        type:
                          - string
                          - 'null'
          description: Successful HTTP response; fixed SDK accepts response.ok.
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.