Skip to content

Custom API

Checkout questions

Reference only. Not a decision unless cited in product/DECISIONS.md.

Checkout questions

An organizer can ask up to 8 questions at checkout. Each is asked once per order or once per ticket. Read them from custom_questions on GET /v1/events/{eventId} and send the answers as custom_answers on POST /v1/orders.

Who this is for

Anyone who builds their own checkout on POST /v1/orders. Hosted checkout and the Web SDK checkout render these questions for you.

Answer kinds

answer_kindShowSend
short_textOne-line text box (120 characters)text
long_textText area (500 characters)text
single_selectOne choice from optionsoption_ids with one id
multi_selectAny of optionsoption_ids
yes_noYes / Noyes_no
acknowledgmentAn unticked checkbox beside promptyes_no: true, once ticked

A per-ticket question (grain: per_ticket) takes one answer per ticket, with ticket_ordinal 1 to the number of tickets. A per-order question takes no ticket_ordinal.

Acknowledgments

An acknowledgment is a condition the guest agrees to before paying, such as "The meal is paid at the venue. All sales are final." It is always required and has no options.

  • Show the full prompt beside a checkbox. Never shorten it or hide it behind a link.
  • The box starts unticked. Never pre-tick it, and never tick it for the guest from saved data or a setting. A pre-ticked box is not agreement.
  • Send yes_no: true only after the guest ticks the box.
  • Anything else is refused with 400 acknowledgment_not_agreed and the question_id: no answer, yes_no: false, text, or option_ids.

AXYN cannot see how your page drew the box, so these rules are yours to keep.

The order stores the agreement, the time, and the exact wording the guest was shown. The organizer sees "Agreed" with the time on the attendee and in the attendee export.

Errors

A refused answer returns 400 with error and question_id:

errorMeaning
acknowledgment_not_agreedAn acknowledgment was not sent as yes_no: true
required custom answer missingA required question has no answer
invalid select custom answerA choice was not sent as option_ids of its own options
custom_answer_question_not_foundThe question is not on this event (it may have been edited)

Wording changes

An organizer can edit questions until the first guest answers. An edit gives every question a new id, so an order built from old questions is refused with custom_answer_question_not_found. Reload the event and ask again.