Eventbrite — Printing Press CLI
Prerequisites: Install the CLI
This skill drives the eventbrite-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
- Install via the Printing Press installer. It defaults binaries to
$HOME/.local/bin on macOS/Linux and %LOCALAPPDATA%\Programs\PrintingPress\bin on Windows:npx -y @mvanhorn/printing-press-library install eventbrite --cli-only
- Verify:
eventbrite-pp-cli --version
- Ensure the reported install directory is on
$PATH for the agent/runtime that will invoke this skill.
If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-cli@latest
If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.
When to Use This CLI
Use this CLI when an agent manages an organizer's Eventbrite presence: creating and publishing events, pulling order and attendee history, and answering cross-event questions (which events sell slowest, which fans return, who the top buyers are, how a discount code performed) that the per-event dashboard and existing single-org MCP servers cannot answer. It is the right tool whenever the task needs the whole order/attendee history in one place rather than a single live API lookup. When the same promoter also sells on DICE, both CLIs emit JSON and a local SQLite store, so an agent can join the two datasets by event (name and date) and by buyer email for a cross-platform performance and loyalty picture.
Unique Capabilities
These capabilities aren't available in any other tool for this API.
Cross-event sales analytics
sales-velocity — Ranks all your live events by tickets sold per day since on-sale and projects a sell-out date.
Reach for this when an agent needs to know which of an organizer's events are underperforming right now, not just current totals.
eventbrite-pp-cli sales-velocity --json
discount-performance — Per discount code: redemptions, type, and the redemption rate (share of the code's allotment used).
Pick this to measure whether a promo code actually drove sales before renewing or killing it.
eventbrite-pp-cli discount-performance --json
capacity — Sold vs total capacity and percent remaining across all your live events at once.
Use this to spot which events are near sell-out or badly under-sold in a single call.
eventbrite-pp-cli capacity --json
refund-rate — Refunded and cancelled order counts, refunded revenue, and the rate per event or across the org.
Pick this to flag events with abnormal refund rates that signal a pricing, date, or fulfillment problem.
eventbrite-pp-cli refund-rate --json
top-buyers — Ranks ticket buyers by total spend across all your events, not just by how many events they attended.
Reach for this to find an organizer's highest-value customers for VIP or pre-sale outreach.
eventbrite-pp-cli top-buyers --limit 25 --json
Search your own data offline
repeat-attendees — Finds fans who bought into two or more of your events, across your whole synced history.
Use this for loyalty and re-marketing questions an agent cannot answer from any one event's attendee list.
eventbrite-pp-cli repeat-attendees --min 2 --json
roster — Offline attendee roster for one event with checked-in vs not-yet, VIP and comp flags, door-sorted.
Reach for this at the door when an agent needs a fast who-has-not-checked-in list without a live API round-trip.
eventbrite-pp-cli roster 1234567890 --csv
fan-export — Exports unique attendee contacts (email, name, events attended, check-in status), deduped across all your events and filterable by event.
Use this to build a clean, deduped contact list for an email campaign across an organizer's whole audience.
eventbrite-pp-cli fan-export --csv
Agency multi-org view
org-rollup — Single pane across every organization your token can see: events count, tickets sold, gross, and top event per org.
Use this for an agency or multi-brand operator who needs one client roll-up instead of logging into each org.
eventbrite-pp-cli org-rollup --json
Command Reference
balance — Manage balance
categories —
Category Object
An overarching category that an event falls into (vertical). Examples are “Music”, and “Endurance”.
eventbrite-pp-cli categories category-by-id — Gets a category by ID as category.
eventbrite-pp-cli categories list-of — Returns a list of Category as categories, including subcategories nested. Returns a paginated response.
discounts —
Discount Object
The Discount object represents a discount that an Order owner can use when purchasing tickets to an Event.
A Discount can be used to a single Ticket Class or across multiple Ticket Classes for multiple Events simultaneously (known as a cross event Discount).
There are four types of Discounts:
Public Discount. Publically displays Discount to Order owner on the Event Listing and Checkout pages. Only used with a single Event.
Coded Discount. Requires Order owner to use a secret code to access the Discount.
Access Code. Requires Order owner to use a secret code to access hidden tickets. Access codes can also optionally contain a discount amount.
Hold Discount. Allows Order owner to apply or unlock Discount for seats on hold.
The display price of a ticket is calculated as:
price_before_discount - discount_amount = display_price
Notes:
Public and Coded Discounts can specify either an amount off or a percentage off, but not both types discounts.
Public Discounts should not contain apostrophes or non-alphanumeric characters (except “-���, “_”, ” ”, “(”, ”)”, “/”, and “”).
Coded Discounts and Access Codes should not contain spaces, apostrophes or non-alphanumeric characters (except “-”, “_”, “(”, ”)”, “/”, and “”).
Fields
Use these fields to specify information about a Discount.
| Field |
Type |
Description |
code |
string |
Discount name for a Public Discount, or the code for a Coded Discount and Access Code. |
type |
string |
Discount type. Can be access, coded, public or hold. |
end_date |
datetime |
Date until which the Discount code is usable. Date is naive and assumed relative to the timezone of an Event. If null or empty, the discount is usable until the Event end_date. ISO 8601 notation: YYYY-MM-DDThh:mm:ss. |
end_date_relative |
integer |
End time in seconds before the start of the Event until which the Discount code is usable. If null or empty, the discount is usable until the Event end_date. |
amount_off |
decimal |
Fixed amount applied as a Discount. This amount is not expressed with a currency; instead uses the Event currency from 0.01 to 99999.99. Only two decimals are allowed. The default is null for an Access Code. |
percent_off |
decimal |
Percentage amount applied as a Discount. Displayed in the ticket price during checkout, from 1.00 to 100.00. Only two decimals are allowed. The default is null for an Access Code. |
quantity_available |
integer |
Number of times this Discount can be used; 0 indicates unlimited use. |
quantity_sold |
integer |
Number of times this Discount has been used. This is a read only field. |
start_date |
local datetime |
Date from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
start_date_relative |
integer |
Start time in seconds before the start of the Event from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
ticket_class_ids |
list |
List of discounted Ticket Class IDs for a single Event. Leave empty if you want to see all the tickets for the Event. |
event_id |
string |
Single Event ID to which the Discount can be used. Leave empty for Discounts. |
ticket_group_id |
string |
Ticket Group ID to which the Discount can be used. |
hold_ids |
list |
List of hold IDs this discount can unlock. Null if this discount does not unlock a hold. |
The following conditions define the extend of the Discount:
If event_id is provided and ticket_class_ids are not provided, a single Event Discount is created for all Event tickets.
If both event_id and ticket_class_ids are provided, a single Event Discount is created for the specific Event tickets.
If ticket_group_id is provided, a Discount is created for the Ticket Group.
If neither event_id nor ticket_group_id are provided, a Discount is created that applies to all tickets for an Organization's Events, including future Events.
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
event |
event_id |
Single Event to which the Discount can be used. |
ticket_group |
ticket_group_id |
Ticket Group to which the Discount can be used. |
reserved_seating |
ticket-reserved-seating-settings |
Reserved seating settings for the Ticket Class. This expansion is not returned for Ticket Classes that do not support reserved seasting. |
eventbrite-pp-cli discounts delete-a — Delete a Discount. Only unused Discounts can be deleted.
eventbrite-pp-cli discounts retrieve-a — Retrieve a Discount by Discount ID.
eventbrite-pp-cli discounts update-a — Update a Discount by Discount ID.
event —
Event Object
The Event object represents an Eventbrite Event. An Event is owned by one Organization.
Public Fields
Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite Users and Eventbrite applications.
| Field |
Type |
Description |
name |
multipart-text |
Event name. |
summary |
string |
(Optional) Event summary. Short summary describing the event and its purpose. |
description |
multipart-text |
(DEPRECATED) (Optional) Event description. Description can be lengthy and have significant formatting. |
url |
string |
URL of the Event's Listing page on eventbrite.com. |
start |
datetime-tz |
Event start date and time. |
end |
datetime-tz |
Event end date and time. |
created |
datetime |
Event creation date and time. |
changed |
datetime |
Date and time of most recent changes to the Event. |
published |
datetime |
Event publication date and time. |
status |
string |
Event status. Can be draft, live, started, ended, completed and canceled. |
currency |
string |
Event ISO 4217 currency code. |
online_event |
boolean |
true = Specifies that the Event is online only (i.e. the Event does not have a Venue). |
hide_start_date |
boolean |
If true, the event's start date should never be displayed to attendees. |
hide_end_date |
boolean |
If true, the event's end date should never be displayed to attendees. |
Private Fields
Use these fields to specify properties of an Event that are only available to the User.
| Field |
Type |
Description |
listed |
boolean |
true = Allows the Event to be publicly searchable on the Eventbrite website. |
shareable |
boolean |
true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
invite_only |
boolean |
true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
show_remaining |
boolean |
true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
password |
string |
Event password used by visitors to access the details of the Event. |
capacity |
integer |
Maximum number of tickets for the Event that can be sold to Attendees. The total capacity is calculated by the sum of the quantity_total of the Ticket Class. |
capacity_is_custom |
boolean |
true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
Music Properties
The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the music_properties expansion.
| Field |
Type |
Description |
age_restriction |
enum |
Minimum age requirement of event attendees. |
presented_by |
string |
Main music event sponsor. |
door_time |
string |
Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
logo |
logo_id |
Event image logo. |
venue |
venue_id |
Event Venue. |
organizer |
organizer_id |
Event Organizer. |
format |
format_id |
Event Format. |
category |
category_id |
Event Category. |
subcategory |
subcategory_id |
Event Subcategory. |
bookmark_info |
bookmark_info |
Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like {count:3}. |
refund_policy |
refund_policy |
Event Refund Policy. |
ticket_availability |
ticket_availability |
Overview of availability of all Ticket Classes |
external_ticketing |
external_ticketing |
External ticketing data for the Event. |
music_properties |
music_properties |
Event Music Properties |
publish_settings |
publish_settings |
Event publish settings. |
basic_inventory_info |
basic_inventory_info |
Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
event_sales_status |
event_sales_status |
Event’s sales status details |
checkout_settings |
checkout_settings |
Event checkout and payment settings. |
listing_properties |
listing_properties |
Display/listing details about the event |
has_digital_content |
has_digital_content |
Whether or not an event Has Digital Content |
events —
Event Object
The Event object represents an Eventbrite Event. An Event is owned by one Organization.
Public Fields
Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite Users and Eventbrite applications.
| Field |
Type |
Description |
name |
multipart-text |
Event name. |
summary |
string |
(Optional) Event summary. Short summary describing the event and its purpose. |
description |
multipart-text |
(DEPRECATED) (Optional) Event description. Description can be lengthy and have significant formatting. |
url |
string |
URL of the Event's Listing page on eventbrite.com. |
start |
datetime-tz |
Event start date and time. |
end |
datetime-tz |
Event end date and time. |
created |
datetime |
Event creation date and time. |
changed |
datetime |
Date and time of most recent changes to the Event. |
published |
datetime |
Event publication date and time. |
status |
string |
Event status. Can be draft, live, started, ended, completed and canceled. |
currency |
string |
Event ISO 4217 currency code. |
online_event |
boolean |
true = Specifies that the Event is online only (i.e. the Event does not have a Venue). |
hide_start_date |
boolean |
If true, the event's start date should never be displayed to attendees. |
hide_end_date |
boolean |
If true, the event's end date should never be displayed to attendees. |
Private Fields
Use these fields to specify properties of an Event that are only available to the User.
| Field |
Type |
Description |
listed |
boolean |
true = Allows the Event to be publicly searchable on the Eventbrite website. |
shareable |
boolean |
true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
invite_only |
boolean |
true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
show_remaining |
boolean |
true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
password |
string |
Event password used by visitors to access the details of the Event. |
capacity |
integer |
Maximum number of tickets for the Event that can be sold to Attendees. The total capacity is calculated by the sum of the quantity_total of the Ticket Class. |
capacity_is_custom |
boolean |
true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
Music Properties
The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the music_properties expansion.
| Field |
Type |
Description |
age_restriction |
enum |
Minimum age requirement of event attendees. |
presented_by |
string |
Main music event sponsor. |
door_time |
string |
Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
logo |
logo_id |
Event image logo. |
venue |
venue_id |
Event Venue. |
organizer |
organizer_id |
Event Organizer. |
format |
format_id |
Event Format. |
category |
category_id |
Event Category. |
subcategory |
subcategory_id |
Event Subcategory. |
bookmark_info |
bookmark_info |
Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like {count:3}. |
refund_policy |
refund_policy |
Event Refund Policy. |
ticket_availability |
ticket_availability |
Overview of availability of all Ticket Classes |
external_ticketing |
external_ticketing |
External ticketing data for the Event. |
music_properties |
music_properties |
Event Music Properties |
publish_settings |
publish_settings |
Event publish settings. |
basic_inventory_info |
basic_inventory_info |
Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
event_sales_status |
event_sales_status |
Event’s sales status details |
checkout_settings |
checkout_settings |
Event checkout and payment settings. |
listing_properties |
listing_properties |
Display/listing details about the event |
has_digital_content |
has_digital_content |
Whether or not an event Has Digital Content |
eventbrite-pp-cli events delete-an — Delete an Event if the delete is permitted. Returns a boolean indicating the success or failure of the delete action.
eventbrite-pp-cli events retrieve-an — Retrieve an Event by Event ID.
eventbrite-pp-cli events update-an — Update Event by Event ID.
formats —
Format Object
The Format object represents an Event type, for example seminar, workshop or concert. Specifying a Format helps website visitors discover a certain type of Event.
eventbrite-pp-cli formats list — List all available Formats. Returns a paginated response.
eventbrite-pp-cli formats retrieve-a — Retrieve a Format by Format ID.
media —
Media Object
The Media object represents an image that can be included with an Event listing, for example to provide branding or further information on the Event.
eventbrite-pp-cli media retrieve — Retrieve Media by Media ID.
eventbrite-pp-cli media retrieve-a-upload — Retrieve information on a Media image upload.
eventbrite-pp-cli media upload-a-file — Upload a Media image file.
orders —
Order object
The Order object represents an order made against Eventbrite for one or more Ticket Classes. In other words, a single Order can be made up of multiple tickets. The object contains an Order's financial and transactional information; use the Attendee object to return information on Attendees.
Order objects are considered private; meaning that all Order information is only available to the Eventbrite User and Order owner.
Order Fields
| Field |
Type |
Description |
created |
datetime |
Date and time the Order was placed and the Attendee created. |
…(truncated)
1---2name: pp-eventbrite3description: Every Eventbrite organizer endpoint, plus a local SQLite mirror of your events, orders Trigger phrases: `sync my eventbrite events`, `which of my events are selling slowest`, `find repeat attendees on eventbrite`, `check in roster for my event`, `how did my discount code perform`, `use eventbrite`, `run eventbrite`.4license: Apache-2.05---6<!-- GENERATED FILE — DO NOT EDIT.
7 This file is a verbatim mirror of library/media-and-entertainment/eventbrite/SKILL.md,
8 regenerated post-merge by tools/generate-skills/. Hand-edits here are
9 silently overwritten on the next regen. Edit the library/ source instead.
10 See the repository agent guide, section "Generated artifacts: registry.json, cli-skills/". -->
11
12# Eventbrite — Printing Press CLI
13
14## Prerequisites: Install the CLI
15
16This skill drives the `eventbrite-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first:
17
181. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows:
19 ```bash
20 npx -y @mvanhorn/printing-press-library install eventbrite --cli-only
21 ```
222. Verify: `eventbrite-pp-cli --version`
233. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill.
24
25If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
26
27```bash
28go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-cli@latest
29```
30
31If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds.
32
33## When to Use This CLI
34
35Use this CLI when an agent manages an organizer's Eventbrite presence: creating and publishing events, pulling order and attendee history, and answering cross-event questions (which events sell slowest, which fans return, who the top buyers are, how a discount code performed) that the per-event dashboard and existing single-org MCP servers cannot answer. It is the right tool whenever the task needs the whole order/attendee history in one place rather than a single live API lookup. When the same promoter also sells on DICE, both CLIs emit JSON and a local SQLite store, so an agent can join the two datasets by event (name and date) and by buyer email for a cross-platform performance and loyalty picture.
36
37## Unique Capabilities
38
39These capabilities aren't available in any other tool for this API.
40
41### Cross-event sales analytics
42- **`sales-velocity`** — Ranks all your live events by tickets sold per day since on-sale and projects a sell-out date.
43
44 _Reach for this when an agent needs to know which of an organizer's events are underperforming right now, not just current totals._
45
46 ```bash
47 eventbrite-pp-cli sales-velocity --json
48 ```
49- **`discount-performance`** — Per discount code: redemptions, type, and the redemption rate (share of the code's allotment used).
50
51 _Pick this to measure whether a promo code actually drove sales before renewing or killing it._
52
53 ```bash
54 eventbrite-pp-cli discount-performance --json
55 ```
56- **`capacity`** — Sold vs total capacity and percent remaining across all your live events at once.
57
58 _Use this to spot which events are near sell-out or badly under-sold in a single call._
59
60 ```bash
61 eventbrite-pp-cli capacity --json
62 ```
63- **`refund-rate`** — Refunded and cancelled order counts, refunded revenue, and the rate per event or across the org.
64
65 _Pick this to flag events with abnormal refund rates that signal a pricing, date, or fulfillment problem._
66
67 ```bash
68 eventbrite-pp-cli refund-rate --json
69 ```
70- **`top-buyers`** — Ranks ticket buyers by total spend across all your events, not just by how many events they attended.
71
72 _Reach for this to find an organizer's highest-value customers for VIP or pre-sale outreach._
73
74 ```bash
75 eventbrite-pp-cli top-buyers --limit 25 --json
76 ```
77
78### Search your own data offline
79- **`repeat-attendees`** — Finds fans who bought into two or more of your events, across your whole synced history.
80
81 _Use this for loyalty and re-marketing questions an agent cannot answer from any one event's attendee list._
82
83 ```bash
84 eventbrite-pp-cli repeat-attendees --min 2 --json
85 ```
86- **`roster`** — Offline attendee roster for one event with checked-in vs not-yet, VIP and comp flags, door-sorted.
87
88 _Reach for this at the door when an agent needs a fast who-has-not-checked-in list without a live API round-trip._
89
90 ```bash
91 eventbrite-pp-cli roster 1234567890 --csv
92 ```
93- **`fan-export`** — Exports unique attendee contacts (email, name, events attended, check-in status), deduped across all your events and filterable by event.
94
95 _Use this to build a clean, deduped contact list for an email campaign across an organizer's whole audience._
96
97 ```bash
98 eventbrite-pp-cli fan-export --csv
99 ```
100
101### Agency multi-org view
102- **`org-rollup`** — Single pane across every organization your token can see: events count, tickets sold, gross, and top event per org.
103
104 _Use this for an agency or multi-brand operator who needs one client roll-up instead of logging into each org._
105
106 ```bash
107 eventbrite-pp-cli org-rollup --json
108 ```
109
110## Command Reference
111
112**balance** — Manage balance
113
114
115**categories** — <a name="categories_object"></a>
116
117## Category Object
118
119An overarching category that an event falls into (vertical). Examples are “Music”, and “Endurance”.
120
121- `eventbrite-pp-cli categories category-by-id` — Gets a `category` by ID as ``category``.
122- `eventbrite-pp-cli categories list-of` — Returns a list of Category as categories, including subcategories nested. Returns a paginated response.
123
124**discounts** — <a name="discount_object"></a>
125
126## Discount Object
127
128The Discount object represents a discount that an Order owner can use when purchasing tickets to an [Event](#event_object).
129
130A Discount can be used to a single [Ticket Class](#ticket_class_object) or across multiple Ticket Classes for multiple Events simultaneously (known as a cross event Discount).
131
132There are four types of Discounts:
133
134+ **Public Discount.** Publically displays Discount to Order owner on the Event Listing and Checkout pages. Only used with a single Event.
135
136+ **Coded Discount.** Requires Order owner to use a secret code to access the Discount.
137
138+ **Access Code.** Requires Order owner to use a secret code to access hidden tickets. Access codes can also optionally contain a discount amount.
139
140+ **Hold Discount.** Allows Order owner to apply or unlock Discount for seats on hold.
141
142The display price of a ticket is calculated as: \
143`price_before_discount` - `discount_amount` = `display_price`
144
145Notes:
146
147* Public and Coded Discounts can specify either an amount off or a percentage off, but not both types discounts.
148
149* Public Discounts should not contain apostrophes or non-alphanumeric characters (except “-���, “_”, ” ”, “(”, ”)”, “/”, and “”).
150
151* Coded Discounts and Access Codes should not contain spaces, apostrophes or non-alphanumeric characters (except “-”, “_”, “(”, ”)”, “/”, and “”).
152
153#### Fields
154
155Use these fields to specify information about a Discount.
156
157| Field | Type | Description |
158| :-------------------- | :--------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
159| `code` | `string` | Discount name for a Public Discount, or the code for a Coded Discount and Access Code. |
160| `type` | `string` | Discount type. Can be `access`, `coded`, `public` or `hold`. |
161| `end_date` | `datetime` | Date until which the Discount code is usable. Date is naive and assumed relative to the timezone of an Event. If null or empty, the discount is usable until the Event end_date. ISO 8601 notation: `YYYY-MM-DDThh:mm:ss`.|
162| `end_date_relative` | `integer` | End time in seconds before the start of the Event until which the Discount code is usable. If null or empty, the discount is usable until the Event end_date. |
163| `amount_off` | `decimal` | Fixed amount applied as a Discount. This amount is not expressed with a currency; instead uses the Event currency from 0.01 to 99999.99. Only two decimals are allowed. The default is `null` for an Access Code. |
164| `percent_off` | `decimal` | Percentage amount applied as a Discount. Displayed in the ticket price during checkout, from 1.00 to 100.00. Only two decimals are allowed. The default is `null` for an Access Code. |
165| `quantity_available` | `integer` | Number of times this Discount can be used; `0` indicates unlimited use. |
166| `quantity_sold` | `integer` | Number of times this Discount has been used. This is a read only field. |
167| `start_date` | `local datetime` | Date from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
168| `start_date_relative` | `integer` | Start time in seconds before the start of the Event from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
169| `ticket_class_ids` | `list` | List of discounted Ticket Class IDs for a single Event. Leave empty if you want to see all the tickets for the Event. |
170| `event_id` | `string` | Single Event ID to which the Discount can be used. Leave empty for Discounts. |
171| `ticket_group_id` | `string` | [Ticket Group](#ticket_group_object) ID to which the Discount can be used. |
172| `hold_ids` | `list` | List of hold IDs this discount can unlock. Null if this discount does not unlock a hold. |
173
174The following conditions define the extend of the Discount:
175
176* If `event_id` is provided and `ticket_class_ids` are not provided, a single Event Discount is created for all Event tickets.
177
178* If both `event_id` and `ticket_class_ids` are provided, a single Event Discount is created for the specific Event tickets.
179
180* If `ticket_group_id` is provided, a Discount is created for the Ticket Group.
181
182* If neither `event_id` nor `ticket_group_id` are provided, a Discount is created that applies to all tickets for an [Organization's](#organization_object) Events, including future Events.
183
184#### Expansions
185
186Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
187
188| Expansion | Source | Description |
189| :----------------- | :--------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
190| `event` | `event_id` | Single Event to which the Discount can be used. |
191| `ticket_group` | `ticket_group_id` | Ticket Group to which the Discount can be used. |
192| `reserved_seating` | `ticket-reserved-seating-settings` | Reserved seating settings for the [Ticket Class](#ticket_class_object). This expansion is not returned for Ticket Classes that do not support reserved seasting. |
193
194- `eventbrite-pp-cli discounts delete-a` — Delete a Discount. Only unused Discounts can be deleted.
195- `eventbrite-pp-cli discounts retrieve-a` — Retrieve a Discount by Discount ID.
196- `eventbrite-pp-cli discounts update-a` — Update a Discount by Discount ID.
197
198**event** — <a name="event_object"></a>
199
200## Event Object
201
202The Event object represents an Eventbrite Event. An Event is owned by one [Organization](#organization_object).
203
204#### Public Fields
205
206Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite [Users](#user_object) and Eventbrite applications.
207
208| Field | Type | Description |
209| :---------------- | :--------------- | ------------------------------------------------------------------------------------------------------- |
210| `name` | `multipart-text` | Event name. |
211| `summary` | `string` | (Optional) Event summary. Short summary describing the event and its purpose. |
212| `description` | `multipart-text` | (*DEPRECATED*) (Optional) Event description. Description can be lengthy and have significant formatting. |
213| `url` | `string` | URL of the Event's Listing page on eventbrite.com. |
214| `start` | `datetime-tz` | Event start date and time. |
215| `end` | `datetime-tz` | Event end date and time. |
216| `created` | `datetime` | Event creation date and time. |
217| `changed` | `datetime` | Date and time of most recent changes to the Event. |
218| `published` | `datetime` | Event publication date and time. |
219| `status` | `string` | Event status. Can be `draft`, `live`, `started`, `ended`, `completed` and `canceled`. |
220| `currency` | `string` | Event [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
221| `online_event` | `boolean` | true = Specifies that the Event is online only (i.e. the Event does not have a [Venue](#venue_object)). |
222| `hide_start_date` | `boolean` | If true, the event's start date should never be displayed to attendees. |
223| `hide_end_date` | `boolean` | If true, the event's end date should never be displayed to attendees. |
224
225#### Private Fields
226
227Use these fields to specify properties of an Event that are only available to the [User](#user_object).
228
229| Field | Type | Description |
230| :------------------- | :-------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
231| `listed` | `boolean` | true = Allows the Event to be publicly searchable on the Eventbrite website. |
232| `shareable` | `boolean` | true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
233| `invite_only` | `boolean` | true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
234| `show_remaining` | `boolean` | true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
235| `password` | `string` | Event password used by visitors to access the details of the Event. |
236| `capacity` | `integer` | Maximum number of tickets for the Event that can be sold to [Attendees](#attendee_object). The total capacity is calculated by the sum of the quantity_total of the [Ticket Class](#ticket_class_object). |
237| `capacity_is_custom` | `boolean` | true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
238
239<a name="music_properties_object"></a>
240
241#### Music Properties
242
243The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the `music_properties` expansion.
244
245| Field | Type | Description |
246| :---------------- | :------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
247| `age_restriction` | `enum` | Minimum age requirement of event attendees. |
248| `presented_by` | `string` | Main music event sponsor. |
249| `door_time` | `string` | Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
250
251<a name="event_expansions" />
252
253#### Expansions
254
255Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
256
257| Expansion | Source | Description |
258| :------------------------ | :-------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
259| `logo` | `logo_id` | Event image logo. |
260| `venue` | `venue_id` | Event [Venue](#venue_object). |
261| `organizer` | `organizer_id` | Event [Organizer](#organizer_object). |
262| `format` | `format_id` | Event [Format](#formats_object). |
263| `category` | `category_id` | Event [Category](#categories_object). |
264| `subcategory` | `subcategory_id` | Event [Subcategory](#subcategories_object). |
265| `bookmark_info` | `bookmark_info` | Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like `{count:3}`. |
266| `refund_policy` | `refund_policy` | Event [Refund Policy](#refund_policy_object). |
267| `ticket_availability` | `ticket_availability` | Overview of availability of all Ticket Classes |
268| `external_ticketing` | `external_ticketing` | External ticketing data for the Event. |
269| `music_properties` | `music_properties` | Event [Music Properties](#music_properties_object) |
270| `publish_settings` | `publish_settings` | Event publish settings. |
271| `basic_inventory_info` | `basic_inventory_info`| Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
272| `event_sales_status` | `event_sales_status` | Event’s sales status details |
273| `checkout_settings ` | `checkout_settings` | Event checkout and payment settings. |
274| `listing_properties` | `listing_properties` | Display/listing details about the event |
275| `has_digital_content` | `has_digital_content` | Whether or not an event [Has Digital Content](#has_digital_content_object) |
276
277
278**events** — <a name="event_object"></a>
279
280## Event Object
281
282The Event object represents an Eventbrite Event. An Event is owned by one [Organization](#organization_object).
283
284#### Public Fields
285
286Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite [Users](#user_object) and Eventbrite applications.
287
288| Field | Type | Description |
289| :---------------- | :--------------- | ------------------------------------------------------------------------------------------------------- |
290| `name` | `multipart-text` | Event name. |
291| `summary` | `string` | (Optional) Event summary. Short summary describing the event and its purpose. |
292| `description` | `multipart-text` | (*DEPRECATED*) (Optional) Event description. Description can be lengthy and have significant formatting. |
293| `url` | `string` | URL of the Event's Listing page on eventbrite.com. |
294| `start` | `datetime-tz` | Event start date and time. |
295| `end` | `datetime-tz` | Event end date and time. |
296| `created` | `datetime` | Event creation date and time. |
297| `changed` | `datetime` | Date and time of most recent changes to the Event. |
298| `published` | `datetime` | Event publication date and time. |
299| `status` | `string` | Event status. Can be `draft`, `live`, `started`, `ended`, `completed` and `canceled`. |
300| `currency` | `string` | Event [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
301| `online_event` | `boolean` | true = Specifies that the Event is online only (i.e. the Event does not have a [Venue](#venue_object)). |
302| `hide_start_date` | `boolean` | If true, the event's start date should never be displayed to attendees. |
303| `hide_end_date` | `boolean` | If true, the event's end date should never be displayed to attendees. |
304
305#### Private Fields
306
307Use these fields to specify properties of an Event that are only available to the [User](#user_object).
308
309| Field | Type | Description |
310| :------------------- | :-------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
311| `listed` | `boolean` | true = Allows the Event to be publicly searchable on the Eventbrite website. |
312| `shareable` | `boolean` | true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
313| `invite_only` | `boolean` | true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
314| `show_remaining` | `boolean` | true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
315| `password` | `string` | Event password used by visitors to access the details of the Event. |
316| `capacity` | `integer` | Maximum number of tickets for the Event that can be sold to [Attendees](#attendee_object). The total capacity is calculated by the sum of the quantity_total of the [Ticket Class](#ticket_class_object). |
317| `capacity_is_custom` | `boolean` | true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
318
319<a name="music_properties_object"></a>
320
321#### Music Properties
322
323The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the `music_properties` expansion.
324
325| Field | Type | Description |
326| :---------------- | :------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
327| `age_restriction` | `enum` | Minimum age requirement of event attendees. |
328| `presented_by` | `string` | Main music event sponsor. |
329| `door_time` | `string` | Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
330
331<a name="event_expansions" />
332
333#### Expansions
334
335Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
336
337| Expansion | Source | Description |
338| :------------------------ | :-------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
339| `logo` | `logo_id` | Event image logo. |
340| `venue` | `venue_id` | Event [Venue](#venue_object). |
341| `organizer` | `organizer_id` | Event [Organizer](#organizer_object). |
342| `format` | `format_id` | Event [Format](#formats_object). |
343| `category` | `category_id` | Event [Category](#categories_object). |
344| `subcategory` | `subcategory_id` | Event [Subcategory](#subcategories_object). |
345| `bookmark_info` | `bookmark_info` | Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like `{count:3}`. |
346| `refund_policy` | `refund_policy` | Event [Refund Policy](#refund_policy_object). |
347| `ticket_availability` | `ticket_availability` | Overview of availability of all Ticket Classes |
348| `external_ticketing` | `external_ticketing` | External ticketing data for the Event. |
349| `music_properties` | `music_properties` | Event [Music Properties](#music_properties_object) |
350| `publish_settings` | `publish_settings` | Event publish settings. |
351| `basic_inventory_info` | `basic_inventory_info`| Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
352| `event_sales_status` | `event_sales_status` | Event’s sales status details |
353| `checkout_settings ` | `checkout_settings` | Event checkout and payment settings. |
354| `listing_properties` | `listing_properties` | Display/listing details about the event |
355| `has_digital_content` | `has_digital_content` | Whether or not an event [Has Digital Content](#has_digital_content_object) |
356
357- `eventbrite-pp-cli events delete-an` — Delete an Event if the delete is permitted. Returns a boolean indicating the success or failure of the delete action.
358- `eventbrite-pp-cli events retrieve-an` — Retrieve an Event by Event ID.
359- `eventbrite-pp-cli events update-an` — Update Event by Event ID.
360
361**formats** — <a name="formats_object"></a>
362
363## Format Object
364
365The Format object represents an [Event](#event_object) type, for example seminar, workshop or concert. Specifying a Format helps website visitors discover a certain type of Event.
366
367- `eventbrite-pp-cli formats list` — List all available Formats. Returns a paginated response.
368- `eventbrite-pp-cli formats retrieve-a` — Retrieve a Format by Format ID.
369
370**media** — <!-- Here is a tutorial on [Media Upload in EventBrite](https://www.eventbrite.com/developer/v3/resources/uploads/). -->
371
372<a name="media_object"></a>
373
374## Media Object
375
376The Media object represents an image that can be included with an [Event](#event_object) listing, for example to provide branding or further information on the Event.
377
378- `eventbrite-pp-cli media retrieve` — Retrieve Media by Media ID.
379- `eventbrite-pp-cli media retrieve-a-upload` — Retrieve information on a Media image upload.
380- `eventbrite-pp-cli media upload-a-file` — Upload a Media image file.
381
382**orders** — <a name="order_object"></a>
383
384## Order object
385
386The Order object represents an order made against Eventbrite for one or more [Ticket Classes](#ticket_class_object). In other words, a single Order can be made up of multiple tickets. The object contains an Order's financial and transactional information; use the [Attendee](#attendee_object) object to return information on Attendees.
387
388Order objects are considered private; meaning that all Order information is only available to the Eventbrite [User](#user_object) and Order owner.
389
390#### Order Fields
391
392| Field | Type | Description |
393| :--------------- | :---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
394| `created` | `datetime` | Date and time the Order was placed and the Attendee created.
395
396…(truncated)