Skip to content

Refund an order​

POST
/event-orders/{id}/refund

All of it (every ticket, the gift and a covered fee) or some tickets, until 30 days after the event. Split by the same shares across the gifts; a gift already paid out has its transfer reversed by its part; each gift's ledger reverses through the existing refund path. Any open refund request is closed as refunded. Audited, with the hosts' note, which the buyer's refund email also carries.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"all": true,
"ticket_ids": [
"string"
],
"note": "string"
}

Responses​

Refunded.

application/json
JSON
{
"id": "string",
"status": "string",
"refunded_cents": 0
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress