Objects

What the API answers with and webhooks carry. Each object names itself in its object field; fields may be added, so ignore those you do not know.

Company

"object": "company"

The company the key belongs to.

idinteger
The company's number on AVEO EOS.
slugstring
Its shop address on EOS.
namestring
Its name.
shop_urlstring
The company's ticket shop on EOS.
currencystring
Its usual currency (ISO 4217).
timezonestring
Its time zone.
contactobject
Email, phone and website, as set on the company.
emailstring
Contact email.
phonestring or null
Contact phone.
websitestring or null
Website.
card_paymentsboolean
Whether the company can take card payments now (its Stripe account is connected and active).
livemodeboolean
False in the company's sandbox, where everything is test data and payments use Stripe's test mode.
Example
{
  "object": "company",
  "id": 12,
  "slug": "acme-events",
  "name": "Acme Events",
  "shop_url": "https://eos.aveoevents.com/acme-events",
  "currency": "GBP",
  "timezone": "Europe/London",
  "contact": {
    "email": "hello@example.com",
    "phone": null,
    "website": "https://example.com"
  },
  "card_payments": true,
  "livemode": true
}

Event

"object": "event"

An event with its dates, venue and, when asked for, its ticket types.

idinteger
The event's id.
slugstring
Its address in the shop.
titlestring
Its name.
statusstring
on_sale, announced, sold_out, postponed or cancelled.
publishedboolean
Whether it shows in the shop.
categorystring
Its category.
starts_attimestamp
Start (UTC).
ends_attimestamp
End (UTC).
timezonestring
The event's local time zone.
currencystring
Ticket currency (ISO 4217).
price_fromnumber or null
The lowest price of one ticket as a buyer pays it: AVEO's booking fee included, or the door price for a ticket paid at the door.
summarystring
One line about it.
descriptionstring
The full description, paragraphs separated by blank lines.
venueobject
Where it is.
namestring
Venue name.
addressstring
Venue address.
image_urlstring or null
The main picture.
urlstring
The event's page in the company's shop.
gatesarray of objects
The event's doors. Send a gate's id as gate when scanning.
idstring
The gate's id.
namestring
Its name, as stewards see it.
allowarray of strings
The kinds of pass it lets in (such as vip or staff); empty means everyone.
reentryboolean
Whether guests may leave and come back in.
ticket_typesarray of objects
Ticket types, on GET /events/{id} or with expand=ticket_types.
Example
{
  "object": "event",
  "id": 41,
  "slug": "example-night",
  "title": "Example Night",
  "status": "on_sale",
  "published": true,
  "category": "music",
  "starts_at": "2026-12-05T19:00:00.000Z",
  "ends_at": "2026-12-05T23:30:00.000Z",
  "timezone": "Europe/London",
  "currency": "GBP",
  "price_from": 26,
  "summary": "An evening of live music.",
  "description": "Doors at 7pm.\n\nOver 18s only.",
  "venue": {
    "name": "Example Hall",
    "address": "1 Example Street, London"
  },
  "image_url": "https://eos.aveoevents.com/s/acme-events/uploads/hero.jpg",
  "url": "https://eos.aveoevents.com/acme-events/events/example-night",
  "gates": [
    {
      "id": "main",
      "name": "Main entrance",
      "allow": []
    },
    {
      "id": "vip",
      "name": "VIP door",
      "allow": [
        "vip",
        "guest",
        "artist",
        "press",
        "staff",
        "crew",
        "security"
      ]
    }
  ],
  "reentry": true,
  "ticket_types": [
    {
      "object": "ticket_type",
      "id": 9001,
      "product_id": 812,
      "event_id": 41,
      "name": "General admission",
      "description": "Entry from 7pm.",
      "price": 25,
      "booking_fee": 1,
      "price_with_booking_fee": 26,
      "booking_fee_payer": "buyer",
      "paid_at_door": false,
      "door_price": null,
      "currency": "GBP",
      "on_sale": true,
      "sold_out": false,
      "min_per_order": 1,
      "max_per_order": 10,
      "remaining": 180,
      "note": null
    }
  ]
}

Ticket type

"object": "ticket_type"

One price of a ticket for an event, with live availability.

idinteger
The ticket type's id. Use it in checkout items.
product_idinteger
The ticket it is a price of.
event_idinteger
The event.
namestring
Its name.
descriptionstring
What it includes.
pricenumber
Price per ticket online, including taxes; 0 for a ticket paid at the door.
booking_feenumber
AVEO's booking fee on an order of this ticket type alone. Charged once per order on card orders, at the band of the order's most expensive ticket: £10 to £19.99 £0.75, £20 to £49.99 £1.00, £50 to £99.99 £1.50, £100 to £199.99 £2.00, £200 and over £2.50; none under £10, on free tickets or at the door.
price_with_booking_feenumber
price plus booking_fee: what one ticket costs a buyer. Show this from the first price on your pages (the headline price must include mandatory fees).
booking_fee_payerstring
Who pays AVEO's booking fee, as agreed with AVEO: buyer (on top of the price) or company (absorbed in the company's prices; booking_fee is then 0 and price_with_booking_fee equals price).buyercompany
paid_at_doorboolean
Free to book online; its door_price is taken at the door before the guest goes in.
door_pricenumber or null
What is paid at the door.
currencystring
Currency.
on_saleboolean
Inside its sale window.
sold_outboolean
None left.
min_per_orderinteger
Fewest per order.
max_per_orderinteger
Most per order.
remaininginteger or null
Tickets left, when limited.
notestring or null
Why it is off sale, when it is.
Example
{
  "object": "ticket_type",
  "id": 9001,
  "product_id": 812,
  "event_id": 41,
  "name": "General admission",
  "description": "Entry from 7pm.",
  "price": 25,
  "booking_fee": 1,
  "price_with_booking_fee": 26,
  "booking_fee_payer": "buyer",
  "paid_at_door": false,
  "door_price": null,
  "currency": "GBP",
  "on_sale": true,
  "sold_out": false,
  "min_per_order": 1,
  "max_per_order": 10,
  "remaining": 180,
  "note": null
}

Checkout session

"object": "checkout_session"

Tickets held for a buyer, from the moment you choose them until the order is placed or the hold ends.

idstring
The session's id.
statusstring
open, complete, expired or cancelled.
event_idinteger
The event.
order_idstring
The order that will be (or was) placed.
urlstring
Send the buyer here to finish on the company's own EOS checkout (hosted checkout).
expires_attimestamp
When the hold ends and the tickets go back on sale.
currencystring
Currency.
amount_itemsnumber
The tickets and extras after any discount.
booking_feenumber
The booking fee the buyer pays on top: once per order, at the band of its most expensive ticket; 0 when nothing is paid online or when the company absorbs the fee.
booking_fee_payerstring
buyer or company: who pays AVEO's booking fee.buyercompany
amount_totalnumber
What the buyer pays online: amount_items plus booking_fee.
discount_codestring or null
The code applied.
itemsarray of objects
What is held.
paymentobject or null
After complete with card: what Stripe's Payment Element needs.
methodstring
card or free (free orders and tickets paid at the door).
amountnumber
What the card is charged: the order and the booking fee.
booking_feenumber
The booking fee in it.
client_secretstring or null
The PaymentIntent's client secret.
publishable_keystring or null
Stripe publishable key.
stripe_accountstring or null
The company's connected Stripe account, for Stripe.js.
metadataobject
Up to 20 keys of your own, returned as sent.
created_attimestamp
When it was made.
Example
{
  "object": "checkout_session",
  "id": "cs_9f2c4e1a7b3d5f8e0a6c2b4d",
  "status": "open",
  "event_id": 41,
  "order_id": "O-7KQ2M4X",
  "url": "https://eos.aveoevents.com/acme-events/checkout-link/eyJhbGciOi...",
  "expires_at": "2026-11-20T10:30:00.000Z",
  "currency": "GBP",
  "amount_items": 50,
  "booking_fee": 1,
  "booking_fee_payer": "buyer",
  "amount_total": 51,
  "discount_code": null,
  "items": [
    {
      "ticket_type_id": 9001,
      "product_id": 812,
      "name": "General admission",
      "quantity": 2,
      "unit_price": 25,
      "total": 50,
      "price_before_discount": null
    }
  ],
  "payment": null,
  "metadata": {
    "basket": "8812"
  },
  "created_at": "2026-11-20T10:15:00.000Z"
}

Order

"object": "order"

An order and its tickets.

idstring
The order reference, as in the buyer's email (O-XXXXXXX).
numberinteger
The order's number.
event_idinteger
The event.
statusstring
reserved, awaiting_payment, completed, cancelled or abandoned.
payment_statusstring
paid, unpaid, no_payment_required, refunded or partially_refunded.
currencystring
Currency.
totalnumber
The order's tickets and extras.
feesnumber
Fees in the total.
taxnumber
Tax in the total.
discount_codestring or null
The code used.
buyerobject
Who bought it.
first_namestring
First name.
last_namestring
Last name.
emailstring
Email.
itemsarray of objects
Lines of the order.
attendeesarray of objects
One per ticket.
created_attimestamp
When it was placed.
channelstring
Where it came from: shop (the EOS shop), api (your own site or app), issued (tickets issued in EOS) or promoter.shopapiissuedpromoter
checkout_session_idstring or null
The API checkout session it came from.
metadataobject
What your system sent with the checkout session, returned as sent. Empty for orders from elsewhere.
booking_feenumber
AVEO's booking fee the buyer paid by card on top of total, once per order; 0 when no card payment was taken.
Example
{
  "object": "order",
  "id": "O-7KQ2M4X",
  "number": 5501,
  "event_id": 41,
  "status": "completed",
  "payment_status": "paid",
  "currency": "GBP",
  "total": 50,
  "fees": 0,
  "tax": 0,
  "discount_code": null,
  "buyer": {
    "first_name": "Sam",
    "last_name": "Taylor",
    "email": "sam@example.com"
  },
  "items": [
    {
      "ticket_type_id": 9001,
      "product_id": 812,
      "name": "General admission",
      "quantity": 2,
      "unit_price": 25,
      "total": 50,
      "price_before_discount": null
    }
  ],
  "attendees": [
    {
      "object": "attendee",
      "id": "A-7Q2KX9",
      "event_id": 41,
      "order_id": "O-7KQ2M4X",
      "order_number": 5501,
      "ticket_type_id": 9001,
      "ticket_type": "General admission",
      "first_name": "Sam",
      "last_name": "Taylor",
      "email": "sam@example.com",
      "status": "active",
      "checked_in": false,
      "checked_in_at": null
    },
    {
      "object": "attendee",
      "id": "A-3MZP8L",
      "event_id": 41,
      "order_id": "O-7KQ2M4X",
      "order_number": 5501,
      "ticket_type_id": 9001,
      "ticket_type": "General admission",
      "first_name": "Alex",
      "last_name": "Morgan",
      "email": "alex@example.com",
      "status": "active",
      "checked_in": false,
      "checked_in_at": null
    }
  ],
  "created_at": "2026-11-20T10:15:00.000Z",
  "channel": "api",
  "checkout_session_id": "cs_9f2c4e1a7b3d5f8e0a6c2b4d",
  "metadata": {
    "basket": "8812"
  },
  "booking_fee": 1
}

Guest

"object": "attendee"

One ticket and the person holding it.

idstring
The ticket code (also in the QR).
event_idinteger
The event.
order_idstring or null
Its order's reference, when known.
order_numberinteger or null
Its order's number.
ticket_type_idinteger
Its ticket type.
ticket_typestring
The ticket type's name.
first_namestring
First name.
last_namestring
Last name.
emailstring
Email.
statusstring
active, cancelled or awaiting_payment.
checked_inboolean
Inside now.
checked_in_attimestamp or null
Last admitted.
Example
{
  "object": "attendee",
  "id": "A-7Q2KX9",
  "event_id": 41,
  "order_id": "O-7KQ2M4X",
  "order_number": 5501,
  "ticket_type_id": 9001,
  "ticket_type": "General admission",
  "first_name": "Sam",
  "last_name": "Taylor",
  "email": "sam@example.com",
  "status": "active",
  "checked_in": false,
  "checked_in_at": null
}

Check-in

"object": "check_in"

A scan at the door and what happened.

event_idinteger
The event.
attendee_idstring or null
The ticket scanned, when it was one.
resultstring
admitted, readmitted, exited, duplicate, wrong_gate, not_inside, invalid, staff or payment_due (a ticket paid at the door that has not been paid).
okboolean
Let them through.
messagestring
What to show the steward.
namestring or null
The guest's name.
ticket_typestring or null
Their ticket.
gatestring or null
The gate's name.
modestring
entry or exit.
ageinteger or null
The guest's age on the day of the event, when the ticket has a date of birth.
notestring or null
Something the steward should check, such as ID when the ticket type has an age limit and no date of birth.
addonsarray of strings
Extras the guest bought, to hand over or check at the door.
first_scanobject or null
For a duplicate: when and at which gate the ticket first got in. On scans read back from the list, always null.
attimestamp
When.
gatestring or null
The gate's name.
door_paymentobject or null
A ticket paid at the door: its price, and whether the door has taken it. On scans read back from the list, always null.
amountnumber
The door price.
currencystring
Currency.
paidboolean
Taken: recorded when a scan is sent with paid_at_door.
created_attimestamp
When.
Example
{
  "object": "check_in",
  "event_id": 41,
  "attendee_id": "A-7Q2KX9",
  "result": "admitted",
  "ok": true,
  "message": "Admit",
  "name": "Sam Taylor",
  "ticket_type": "General admission",
  "gate": "Main entrance",
  "mode": "entry",
  "age": 27,
  "note": null,
  "addons": [
    "Cloakroom"
  ],
  "first_scan": null,
  "door_payment": null,
  "created_at": "2026-12-05T19:02:11.000Z"
}

Discount code

"object": "discount_code"

A code buyers type at checkout. One code can work on many events.

codestring
The code, in capitals.
discount_typestring
percentage, fixed (amount off each ticket) or none (unlocks hidden tickets).
amountnumber
Percent or amount off.
max_usesinteger or null
Most orders per event.
usesinteger
Orders that used it.
ticketsinteger
Tickets bought with it.
expires_attimestamp or null
When it stops working.
eventsarray of objects
The events it works on, with each one's uses.
Example
{
  "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
    }
  ]
}

Webhook endpoint

"object": "webhook_endpoint"

An address EOS sends signed events to.

idinteger
Its id.
urlstring
Your https address.
descriptionstring
What it is for.
eventsarray of strings
Event types it receives; empty means all.
activeboolean
Receiving events.
created_attimestamp
Added.
last_statusinteger or null
HTTP status of the last attempt.
last_attempt_attimestamp or null
Last attempt.
secretstring
The signing secret: only when the endpoint is made or its secret rolled.
Example
{
  "object": "webhook_endpoint",
  "id": 7,
  "url": "https://example.com/hooks/eos",
  "description": "Orders into our CRM",
  "events": [
    "order.paid",
    "order.refunded"
  ],
  "active": true,
  "created_at": "2026-11-20T09:00:00.000Z",
  "last_status": 200,
  "last_attempt_at": "2026-11-20T10:15:02.000Z"
}

Webhook delivery

"object": "webhook_delivery"

One event sent (or being sent) to one endpoint.

idstring
The webhook-id header value.
typestring
The event type.
created_attimestamp
When it happened.
attemptsinteger
Tries so far.
deliveredboolean
Your endpoint answered 2xx.
delivered_attimestamp or null
When.
next_attempt_attimestamp or null
The next retry.
last_errorstring or null
Why the last try failed.
Example
{
  "object": "webhook_delivery",
  "id": "msg_2c8d4e6f8a0b4c6d8e0f2a4b6c8d0e2f",
  "type": "order.paid",
  "created_at": "2026-11-20T10:15:01.000Z",
  "attempts": 1,
  "delivered": true,
  "delivered_at": "2026-11-20T10:15:02.000Z",
  "next_attempt_at": null,
  "last_error": null
}