Create Refund

Refunds one order item. The item's amount is credited back to the member, the item is restocked, and the item is marked refunded. Refunds are per item, and the item is identified by the URL. Requires a producer access token for the application.

A reason is required. The response is the refund, in the same shape as Retrieve Refund, plus new_balance, the member's current balance in the order's reward item. It is null for a cash order. A refund that can't be issued fails with 422 and an error_code. Built-in products (badge, multiplier, flair and coupon-code lines) settle at order time and can't be refunded, so they fail with 400 PRODUCT_NOT_ACTIONABLE.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

uuid
required

The ID of the order item to refund.

Body Params
string
required
length ≤ 255

Why the item is being refunded. Can't be blank.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json