Skip to main content
POST
Refund an order

Authorizations

ff-secret-key
string
header
required

Secret key for FunnelFox Billing API. Required for all requests.

Path Parameters

org_id
string
required

Organization ID

Body

application/json
external_id
string
required

Your unique identifier for the user

Maximum string 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 string length: 256
comment
string
default:""

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

Maximum string length: 2048
amount

Refund amount (omit for full refund)

soft_refund
boolean
default:false

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

Response

200 - application/json

The response is of type Ok200 · object.