Refund an order

org_id

string

required

Organization ID

application/json

external_id

string

required

Your unique identifier for the user

Maximum length: 256

order_id

string<uuid>

required

Order ID (can include multiple transactions, fallbacks, and refunds)

reason

string

default:""

Short reason code (e.g., "duplicate_payment", "unauthorized_charge")

Maximum length: 256

comment

string

default:""

Human-readable comment or reference (e.g., support ticket link)

Maximum length: 2048

amount

Refund amount (omit for full refund)

soft_refund

boolean

default:false

Keep subscription active (true) or cancel it (false)

200 - application/json

The response is of type object.