Skip to content
HeyX API

Get Order Cancellation Impact

Required scope: order:read

Previews the financial impact of cancelling a confirmed order before acting: whether the order is backed by a payment plan, how much has already been paid, the amount that can still be refunded, and the number of unpaid payment-plan terms remaining. This is a read; it does not cancel the order or move any money. Amounts are integer minor currency units.

Generated Reference
POST /public-api/publicapi.v1.Order/GetOrderCancellationImpact

Previews the payment-plan and refund impact of cancelling an order. Safe read-only operation that does not change order or payment state.

Request GetOrderCancellationImpactRequest
Response GetOrderCancellationImpactResponse

GetOrderCancellationImpactRequest

Field Type Description
order_id string Stable identifier of the order to preview cancellation for.

GetOrderCancellationImpactResponse

Field Type Description
impact OrderCancellationImpact The computed cancellation impact.

Related Types

OrderCancellationImpact

Field Type Description
has_payment_plan bool Whether the order is backed by a payment plan.
paid_amount_minor int64 Amount already paid in minor currency units.
refundable_amount_minor int64 Amount that can still be refunded in minor currency units.
currency string ISO 4217 currency code for the amounts.
unpaid_term_count int32 Number of unpaid payment-plan terms remaining.

Request

Section titled “Request”
{
  "orderId": "<order-id>"
}

Response

Section titled “Response”
{
  "impact": {
    "hasPaymentPlan": true,
    "paidAmountMinor": "50000",
    "refundableAmountMinor": "50000",
    "currency": "EUR",
    "unpaidTermCount": 3
  }
}
HeyX API