v1

latestOpenAPI 3.0.12026-08-062532117.6 KB

Mark a sale as refunded

Marks a sale as refunded and reverses the commission attached to it.

If the sale was already refunded the request still succeeds, with alreadyRefunded set to true. A sale cannot be refunded once it has passed your program's refund window, has been added to a payout batch, has already been paid out, or has been marked as manually paid — each of those returns a 400 with a reason you can branch on.

patch/sales

Request body

saleIdinteger required

The sale ID to mark as refunded

Response

The refund was processed, or the sale was already refunded.

successboolean

Whether the refund request was handled successfully

alreadyRefundedboolean

Whether the sale had already been marked as refunded before this request

reasonstring

Why the request resolved the way it did — for example refunded or already_refunded.