For the complete documentation index, see llms.txt. This page is also available as Markdown.

Credits

Manage group credits (stored-value codes) for the group that owns an event. Credits are group-scoped and usable across every event in the group; they are managed under the event so the event-bound integration can reach them. Returns 422 if the event is not part of a group.

List credits for the event's group

get
Authorizations
AuthorizationstringRequired

Pass the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN
Path parameters
handlestringRequired

The unique handle (slug) of the event

Example: nyc_marathon_2025
Responses
200

OK

application/json
get/api/v1/events/{handle}/credits

Create a credit

post

Creates a credit on the event's group. amount_cents sets both the face value and the starting balance. Returns 422 if the event is not part of a group, if the code is missing or already used within the group, if amount_cents is missing or non-positive, or if the currency is unsupported. When email_credit_to_participant is not false and an email is present, the recipient is emailed.

Authorizations
AuthorizationstringRequired

Pass the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN
Path parameters
handlestringRequired

The unique handle (slug) of the event

Example: nyc_marathon_2025
Body
codestringRequired
currencystring · enumOptionalPossible values:
expiration_datestring · date-timeOptional
first_namestringOptional
last_namestringOptional
emailstringOptional
applies_to_merchandisebooleanOptional
email_credit_to_participantbooleanOptional

Defaults to true; set false to suppress the recipient email on create.

amount_centsinteger · min: 1Required
Responses
201

Created

application/json
post/api/v1/events/{handle}/credits

Get a credit

get
Authorizations
AuthorizationstringRequired

Pass the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN
Path parameters
handlestringRequired

The unique handle (slug) of the event

Example: nyc_marathon_2025
idinteger · int64Required

The ID of the resource

Example: 1
Responses
200

OK

application/json
get/api/v1/events/{handle}/credits/{id}

Delete a credit

delete

Deletes a credit. Returns 422 if the credit has already been used (it has usage records representing money applied to participants).

Authorizations
AuthorizationstringRequired

Pass the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN
Path parameters
handlestringRequired

The unique handle (slug) of the event

Example: nyc_marathon_2025
idinteger · int64Required

The ID of the resource

Example: 1
Responses
200

OK

application/json
okbooleanRequired
delete/api/v1/events/{handle}/credits/{id}

Update a credit

patch

Updates credit metadata. amount_cents, when supplied, is treated as the new face value: the same delta is applied to the remaining balance so the ledger stays reconciled. A decrease below the amount already spent is rejected with 422.

Authorizations
AuthorizationstringRequired

Pass the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN
Path parameters
handlestringRequired

The unique handle (slug) of the event

Example: nyc_marathon_2025
idinteger · int64Required

The ID of the resource

Example: 1
Body
codestringOptional
currencystring · enumOptionalPossible values:
expiration_datestring · date-timeOptional
first_namestringOptional
last_namestringOptional
emailstringOptional
applies_to_merchandisebooleanOptional
email_credit_to_participantbooleanOptional

Defaults to true; set false to suppress the recipient email on create.

amount_centsinteger · min: 1Optional

New face value; the same delta is applied to the remaining balance.

Responses
200

OK

application/json
patch/api/v1/events/{handle}/credits/{id}

Last updated