Skip to content
Docs
Reference

<tl-refund-request>

Ask for a refund on an order, with a reason and where the money should go: back the way it was paid, or as account credit.

HTML tag<tl-refund-request>
Reactimport { TlRefundRequest } from '@ticketlayer/elements-react'
CategoryAccount
Runs inweb (browser DOM), native (planned React Native set)

Ask for a refund on an order, with a reason and where the money should go: back the way it was paid, or as account credit. Staff decide the request.

<tl-refund-request order-id="ord_..."></tl-refund-request>

Properties#

PropertyAttributeDescriptionTypeDefault
allowCreditallow-creditOffer account credit as well as a refund the way the order was paid.booleantrue
headingheadingThe form's heading.string'Ask for a refund'
orderId (required)order-idThe order to ask about.stringundefined
unstyledunstyledRender into the light DOM with no stylesheet, for a page that styles the element itself: every node carries a tl-refund-request__* class. Without it the element is styled, and each node is a ::part() of the same name.booleanfalse

Events#

EventDescriptionType
tlErrorEmitted when the request cannot be sent, with the message shown.CustomEvent<{ message: string; }>
tlRefundRequestedEmitted once the request is sent.CustomEvent<TlRefundRequested>

Events are CustomEvents; the payload is on event.detail. In HTML, listen with element.addEventListener('tlXxx', handler); in React the wrapper exposes each one as an onTlXxx prop.