Discount codes

Codes buyers type at checkout, on one event or many.

List discount codes

GET/api/v1/discount-codes

Every code on upcoming events, one row per code.

Permissiondiscounts:read (Read discount codes)
Publishable keyNo: secret keys only

Query parameters

event_idinteger
Only codes on this event.
Request
curl "https://eos.aveoevents.com/api/v1/discount-codes?event_id=41" \
  -H "Authorization: Bearer $EOS_API_KEY"
200 response
{
  "object": "list",
  "url": "/api/v1/discount-codes",
  "has_more": false,
  "next_cursor": null,
  "data": [
    {
      "object": "discount_code",
      "code": "EARLYBIRD",
      "discount_type": "percentage",
      "amount": 10,
      "max_uses": 100,
      "uses": 3,
      "tickets": 5,
      "expires_at": null,
      "events": [
        {
          "event_id": 41,
          "title": "Example Night",
          "uses": 3
        }
      ]
    }
  ]
}

Every field of the response: the discount code object.

Create a discount code

POST/api/v1/discount-codes

Makes the code on the events you name, or on every upcoming event.

Permissiondiscounts:write (Manage discount codes)
Publishable keyNo: secret keys only
Idempotency-KeyAccepted. How retries stay safe

Body (JSON)

codestringRequired
3 to 30 letters, numbers, - or _. Not case-sensitive.
discount_typestringRequired
percentage, fixed or none.percentagefixednone
amountnumber
Percent (1 to 100) or amount off each ticket. Not for none.
max_usesinteger
Most orders per event.
expires_attimestamp
When it stops working.
event_idsarray of integers
The events. Leave out for every upcoming event.

Errors it can give

  • 409code_existsThe code already exists on one of those events.
  • 422unknown_eventOne of event_ids is not an upcoming event with tickets.
  • 422no_eventsThere are no upcoming events with tickets to put the code on.
  • 422not_createdThe ticket engine refused the code on every event named.
Request
curl -X POST "https://eos.aveoevents.com/api/v1/discount-codes" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"code":"EARLYBIRD","discount_type":"percentage","amount":10,"max_uses":100,"event_ids":[41]}'
201 response
{
  "object": "discount_code",
  "code": "EARLYBIRD",
  "discount_type": "percentage",
  "amount": 10,
  "max_uses": 100,
  "uses": 0,
  "tickets": 0,
  "expires_at": null,
  "events": [
    {
      "event_id": 41,
      "title": "Example Night",
      "uses": 0
    }
  ]
}

Every field of the response: the discount code object.

Delete a discount code

DELETE/api/v1/discount-codes/{code}

Removes the code from every event it is on.

Permissiondiscounts:write (Manage discount codes)
Publishable keyNo: secret keys only

Path parameters

codestringRequired
The code.

Errors it can give

Request
curl -X DELETE "https://eos.aveoevents.com/api/v1/discount-codes/EARLYBIRD" \
  -H "Authorization: Bearer $EOS_API_KEY"
200 response
{
  "object": "discount_code",
  "code": "EARLYBIRD",
  "deleted": true
}

Every field of the response: the discount code object.