Orders

Every order, paid or not: read them, cancel, refund, mark paid and resend tickets.

List orders

GET/api/v1/orders

Orders across every event, newest first.

Permissionorders:read (Read orders)
Publishable keyNo: secret keys only
ListsPaged with limit and cursor. Pagination

Query parameters

event_idinteger
Only this event's orders.
qstring
Search by order reference, name or email.
limitinteger
How many to return, 1 to 100. Default 25.
cursorstring
The next_cursor from the previous page.
Request
curl "https://eos.aveoevents.com/api/v1/orders?event_id=41&limit=25" \
  -H "Authorization: Bearer $EOS_API_KEY"
200 response
{
  "object": "list",
  "url": "/api/v1/orders",
  "has_more": false,
  "next_cursor": null,
  "data": [
    {
      "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
        }
      ],
      "created_at": "2026-11-20T10:15:00.000Z",
      "channel": "api",
      "checkout_session_id": "cs_9f2c4e1a7b3d5f8e0a6c2b4d",
      "metadata": {
        "basket": "8812"
      },
      "booking_fee": 1
    }
  ]
}

Every field of the response: the order object.

Get an order

GET/api/v1/orders/{id}

One order with its items and tickets.

Permissionorders:read (Read orders)
Publishable keyNo: secret keys only

Path parameters

idstringRequired
The order reference (O-XXXXXXX).

Errors it can give

Request
curl "https://eos.aveoevents.com/api/v1/orders/O-7KQ2M4X" \
  -H "Authorization: Bearer $EOS_API_KEY"
200 response
{
  "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
}

Every field of the response: the order object.

Cancel an order

POST/api/v1/orders/{id}/cancel

Cancels the order: its tickets stop working and go back on sale. It does not refund a card payment: call refund for that, which also cancels a fully refunded order.

Permissionorders:write (Manage orders)
Publishable keyNo: secret keys only
Idempotency-KeyAccepted. How retries stay safe

Path parameters

idstringRequired
The order reference (O-XXXXXXX).

Errors it can give

Request
curl -X POST "https://eos.aveoevents.com/api/v1/orders/O-7KQ2M4X/cancel" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
200 response
{
  "object": "order",
  "id": "O-7KQ2M4X",
  "number": 5501,
  "event_id": 41,
  "status": "cancelled",
  "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
}

Every field of the response: the order object.

Refund an order

POST/api/v1/orders/{id}/refund

Refunds the card payment through the company's Stripe account, in full or in part. A full refund cancels the tickets.

Permissionorders:write (Manage orders)
Publishable keyNo: secret keys only
Idempotency-KeyAccepted. How retries stay safe

Path parameters

idstringRequired
The order reference (O-XXXXXXX).

Body (JSON)

amountnumber
How much to refund. Leave out for everything.

Errors it can give

  • 404not_foundNo such object in this company.
  • 422not_refundableThere is no card payment to refund, or the amount is more than was paid.
Request
curl -X POST "https://eos.aveoevents.com/api/v1/orders/O-7KQ2M4X/refund" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":25}'
200 response
{
  "object": "order",
  "id": "O-7KQ2M4X",
  "number": 5501,
  "event_id": 41,
  "status": "completed",
  "payment_status": "partially_refunded",
  "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
}

Every field of the response: the order object.

Mark an order paid

POST/api/v1/orders/{id}/mark-paid

For an order awaiting payment when the money has arrived another way. The tickets are emailed.

Permissionorders:write (Manage orders)
Publishable keyNo: secret keys only
Idempotency-KeyAccepted. How retries stay safe

Path parameters

idstringRequired
The order reference (O-XXXXXXX).

Errors it can give

Request
curl -X POST "https://eos.aveoevents.com/api/v1/orders/O-7KQ2M4X/mark-paid" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
200 response
{
  "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
}

Every field of the response: the order object.

Resend tickets

POST/api/v1/orders/{id}/resend

Emails the order's tickets again to the buyer and guests.

Permissionorders:write (Manage orders)
Publishable keyNo: secret keys only

Path parameters

idstringRequired
The order reference (O-XXXXXXX).

Errors it can give

Request
curl -X POST "https://eos.aveoevents.com/api/v1/orders/O-7KQ2M4X/resend" \
  -H "Authorization: Bearer $EOS_API_KEY"
200 response
{
  "object": "resend",
  "order_id": "O-7KQ2M4X",
  "emails": 2
}