Skip to content

Cancel Conditions ​

Returns the preview of what cancelling the order right now would refund, per ticket — before any cancellation is performed. Use it to show the penalty/refund before a cancellation is confirmed. After the order is actually cancelled, query Refund for the amounts realised.

This is a safe, idempotent read.

Endpoint ​

Method: GET

URL: /v1/order/{order_id}/cancel-conditions

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesBearer <token> from Login

Path Parameters ​

ParameterTypeRequiredDescription
order_idStringYesProvider order id (Order.id returned by Create Order)

Query Parameters ​

ParameterTypeRequiredDescription
localeStringNoLocalises the human-readable refund notes, refer to Locale List

Response Parameters ​

ParameterTypeRequiredDescription
└ conditionsObjectYesPer-order refund summary
  └ can_be_canceledBooleanNoWhether the order may still be cancelled
  └ return_available_tillStringNoDeadline for a return (ISO-8601 with offset)
  └ currencyStringNoOrder-level currency (a ticket may override it)
  └ tickets[RefundTicket]YesPer-ticket refund lines
   └ ticket_codeStringYesProvider booking/system code (matches OrderTicket.code)
   └ currencyStringNoCurrency
   └ refund_amountNumberNoAmount refunded to the customer
   └ refund_fee_amountNumberNoPenalty/fee withheld from the refund
   └ refund_tax_amountNumberNoTax component withheld
   └ full_refundBooleanNoWhole ticket price refunded (ignores per-ticket amounts)
   └ route_changedBooleanNoRefund is due to a provider route change
   └ additional_infoStringNoFree-text note shown to the operator

Response Example ​

json
{
  "conditions": {
    "can_be_canceled": true,
    "return_available_till": "2026-06-30T23:59:00+03:00",
    "currency": "UAH",
    "tickets": [
      {
        "ticket_code": "BK-9931",
        "currency": "UAH",
        "refund_amount": 585.0,
        "refund_fee_amount": 65.0,
        "refund_tax_amount": 0.0,
        "full_refund": false,
        "route_changed": false,
        "additional_info": "10% cancellation fee applies"
      }
    ]
  }
}

Error Code List ​

codemessageDescription
UNAUTHORIZEDInvalid tokenThe bearer token is missing, invalid, or expired (401).
NOT_FOUNDOrder not foundNo order exists for the supplied order_id.
NOT_CANCELABLEOrder cannot be cancelledThe order is already canceled or expired.

TTN Octo API documentation