Orders

Cancel tickets or close an order without a refund

Changed on
post/orders/{id}/cancel

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/orders/{id}/cancel
  • Auth: API key in header x-tenant-id

Path parameters

idstring required

Unique order identifier

Request body

cancelOrderboolean

Close the order and cancel all its tickets. Omit or use false to cancel tickets while allowing replacement issuance.

ticketIdsstring[]

Tickets to cancel. Omit to cancel every ticket on the order.

idempotencyKeystring required

Stable key for this cancellation. Reuse when retrying.

reasonstring required

Reason shown to the buyer and included in their email when notification is enabled, 1–500 characters after trimming.

notifyboolean

Email the order buyer after cancellation.

Response

OK

Changes