Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Ticket Type

createTicketType

Create a Ticket Type for a given Campaign.

post/campaigns/{campaign}/ticket-types

Path parameters

campaigninteger required
Example:227362

Primary identifier of Campaign

Request body

descriptionstring nullable

Description of Ticket Type

ended_atstring date-time nullable

Date when Ticket Type is no longer available

entries_per_ticketinteger

How many entries a Ticket of this type grants to a purchaser

is_activeboolean

Whether Ticket Type is available to purchase

max_per_transactioninteger

The most Tickets of this type that be purchased in a single transaction

namestring

The name of the TicketType

org_percentnumber double nullable

Use deductible_percent

deductible_amountnumber double nullable

Amount of ticket price that is considered donation to campaign (May only specify deductible_percent OR deductible_amount)

deductible_percentnumber double nullable

Percentage of ticket price that is considered donation to campaign (May only specify deductible_percent OR deductible_amount)

pricenumber double

Price of a single Ticket of this type.

quantity_availableinteger nullable

Quantity of Tickets available for purchase. Use 'null' for unlimited tickets.

started_atstring date-time nullable

Date when Ticket Type can start being purchased

weightinteger nullable

Display order

Example request

{
  "commitment": {
    "deadline": "2016-02-01T00:00:00+0000",
    "value": 100
  },
  "description": "Ticket Type description",
  "ended_at": "2019-04-23T10:25:03Z",
  "entries_per_ticket": 3,
  "is_active": true,
  "max_per_transaction": 1,
  "name": "General Admission",
  "org_percent": 100,
  "deductible_amount": 5,
  "deductible_percent": 100,
  "price": 10,
  "quantity_available": 2,
  "started_at": "2016-01-01T12:00:00+0000",
  "weight": 1
}

Response

Success

descriptionstring nullable

Description of Ticket Type

ended_atstring date-time nullable

Date when Ticket Type is no longer available

entries_per_ticketinteger

How many entries a Ticket of this type grants to a purchaser

is_activeboolean

Whether Ticket Type is available to purchase

max_per_transactioninteger

The most Tickets of this type that be purchased in a single transaction

namestring

The name of the TicketType

org_percentnumber double nullable

Use deductible_percent

deductible_amountnumber double nullable

Amount of ticket price that is considered donation to campaign (May only specify deductible_percent OR deductible_amount)

deductible_percentnumber double nullable

Percentage of ticket price that is considered donation to campaign (May only specify deductible_percent OR deductible_amount)

pricenumber double

Price of a single Ticket of this type.

quantity_availableinteger nullable

Quantity of Tickets available for purchase. Use 'null' for unlimited tickets.

started_atstring date-time nullable

Date when Ticket Type can start being purchased

weightinteger nullable

Display order

campaign_idinteger

The ID of the Campaign the Ticket Type belongs to

commitment_idinteger nullable

The ID of the Commitment associated to the TicketType

created_atstring date-time

Timestamp from when TicketType was created

idinteger

Primary identifier of record

is_classy_modeboolean

Whether TicketType is fees on top.

min_per_transactioninteger nullable

The min Tickets of this type that be purchased in a single transaction

quantity_reservedinteger

Quantity of Tickets that are reserved awaiting checkout/payment. Only available for FRS campaigns.

quantity_soldinteger

Quantity of Tickets that have been sold. Only available for FRS campaigns.

updated_atstring date-time

Date when Tickets of this type was last updated

Example response

{
  "commitment": {
    "deadline": "2016-02-01T00:00:00+0000",
    "value": 100
  },
  "description": "Ticket Type description",
  "ended_at": "2019-04-23T10:25:03Z",
  "entries_per_ticket": 3,
  "is_active": true,
  "max_per_transaction": 1,
  "name": "General Admission",
  "org_percent": 100,
  "deductible_amount": 5,
  "deductible_percent": 100,
  "price": 10,
  "quantity_available": 2,
  "started_at": "2016-01-01T12:00:00+0000",
  "weight": 1,
  "campaign_id": 227362,
  "commitment_id": 98374,
  "created_at": "2016-01-01T12:00:00+0000",
  "id": 9978,
  "min_per_transaction": 1,
  "quantity_reserved": 1,
  "quantity_sold": 1,
  "updated_at": "2016-01-01T12:00:00+0000"
}