Events

Create Coupon

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.

post/v1/events/coupons/create

Request body

codestring required

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

remaining_countinteger

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

valid_start_atstring date-time nullable

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

valid_end_atstring date-time nullable

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

event_idstring required

Event ID, this usually starts with evt-

event_ticket_type_idstring

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

Successful response.

idstring required

codestring required

This code is case insensitive.

remaining_countinteger required

valid_start_atstring date-time nullable required

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

valid_end_atstring date-time nullable required

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

percent_offnumber nullable required

cents_offnumber nullable required

currency'solana_sol' | 'solana_usdc' | 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw' nullable required

event_ticket_type_idstring nullable

The ticket type this coupon is restricted to, if any. Set for unlock (access) codes that reveal a hidden ticket type.

Changes

No recorded changes to this endpoint across all 1 revision of this API.