Skip to main content
POST
Cancel or record a refund for event registration

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

eventId
integer
required

Record ID in the authenticated organization.

Example:

42

orderId
integer
required

Record ID in the authenticated organization.

Example:

42

Body

application/json
reason
string | null

Cancellation explanation.

Maximum string length: 1000
Example:

"Guest cannot attend"

refund
boolean | null

Record the order as refunded.

Example:

false

refund_amount
number | null

Recorded refund amount; used only with refund=true.

Required range: x >= 0
Example:

25

refund_reference
string | null

External refund reference.

Maximum string length: 255
Example:

"refund-001"

Response

Cancel or record a refund for event registration completed.

data
object