Create Coupon

post

https://public-api.luma.com/v1/events/coupons/create

Create a coupon that can be applied when a guest is registering for an event. Restrict it to a ticket type with event_ticket_type_id — when that ticket type is hidden, this creates an unlock (access) code. You are not able to edit the coupon terms after it has been created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

code

string

required

length between 1 and 20

This is the code that the user will enter on the event page. It is not case sensitive. Maximum 20 characters.

remaining_count

integer

0 to 1000000

Number of times the coupon can be used. Set to 1000000 for unlimited uses.

valid_start_at

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

valid_end_at

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

discount

required

event_id

string

required

Event ID, this usually starts with evt-

event_ticket_type_id

string

Optional. Restrict the coupon to a single ticket type. If that ticket type is hidden, the coupon acts as an unlock (access) code that reveals the ticket during registration. Pair a hidden ticket type that has Require Approval turned off with an unlock code to let invited guests register and pay directly, skipping the Apply to Attend step. For a code that unlocks the ticket without changing the price, set the discount to 0% (percent_off: 0).

Response

200Successful response.