Get all ticket rates

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/ticket-rates \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "organization_id": "abcdefghi1234567890",
      "event_id": "abcdefghi1234567890",
      "name": "General Access",
      "slug": "general-access",
      "valid_from": "2022-01-01T00:00:00.000Z",
      "complete": false,
      "type": "limited",
      "prices": [
        {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        }
      ],
      "supplements": [
        {
          "_id": "1643064796675",
          "label": "1 Copa",
          "price": 12,
          "has_fake_price": false,
          "fake_price": 15
        }
      ],
      "available": true,
      "availability": {
        "sold": 10,
        "available": 90
      },
      "min": 1,
      "max": 10,
      "questions": [
        {
          "_id": "1643064796675",
          "label": "¿How did you hear about us?",
          "type": "dropdown",
          "required": true,
          "items": [
            "Instagram",
            "Appear"
          ]
        }
      ],
      "_id": "abcdefghi1234567890",
      "show_all_prices": true,
      "current_price": {
        "price": 12,
        "valid_until": "2022-01-01T00:00:00.000Z",
        "quantity": 0,
        "includes": "1 Drink",
        "additional_info": "Only valid before 2:00 am.",
        "_id": "1643064796675",
        "name": "Early Bird",
        "fee_type": "percentage",
        "fee_quantity": 10
      },
      "warranty": {
        "enabled": true,
        "percentage": 20,
        "hours": 12
      }
    }
  ],
  "success": true
}

GET

ticket-rates

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/ticket-rates \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "organization_id": "abcdefghi1234567890",
      "event_id": "abcdefghi1234567890",
      "name": "General Access",
      "slug": "general-access",
      "valid_from": "2022-01-01T00:00:00.000Z",
      "complete": false,
      "type": "limited",
      "prices": [
        {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        }
      ],
      "supplements": [
        {
          "_id": "1643064796675",
          "label": "1 Copa",
          "price": 12,
          "has_fake_price": false,
          "fake_price": 15
        }
      ],
      "available": true,
      "availability": {
        "sold": 10,
        "available": 90
      },
      "min": 1,
      "max": 10,
      "questions": [
        {
          "_id": "1643064796675",
          "label": "¿How did you hear about us?",
          "type": "dropdown",
          "required": true,
          "items": [
            "Instagram",
            "Appear"
          ]
        }
      ],
      "_id": "abcdefghi1234567890",
      "show_all_prices": true,
      "current_price": {
        "price": 12,
        "valid_until": "2022-01-01T00:00:00.000Z",
        "quantity": 0,
        "includes": "1 Drink",
        "additional_info": "Only valid before 2:00 am.",
        "_id": "1643064796675",
        "name": "Early Bird",
        "fee_type": "percentage",
        "fee_quantity": 10
      },
      "warranty": {
        "enabled": true,
        "percentage": 20,
        "hours": 12
      }
    }
  ],
  "success": true
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

event_id

string

required

Filter by event_id (comma separated list)

Response

data

object[]

Show child attributes

data.organization_id

string

required

Ticket rate organization unique identifier.

Example:

"abcdefghi1234567890"

data.event_id

string

required

Event unique identifier.

Example:

"abcdefghi1234567890"

data.name

string

required

Name of the ticket rate.

Example:

"General Access"

data.slug

string

required

Name URL-friendly identifier.

Example:

"general-access"

data.valid_from

string

required

Date when the ticket rate will be available for sale.

Example:

"2022-01-01T00:00:00.000Z"

data.complete

boolean

required

If the ticket rate is marked as complete.

Example:

false

data.type

enum<string>

required

Available options:

limited,

public

Example:

"limited"

data.prices

object[]

required

Prices of the ticket rate.

Show child attributes

data.prices.price

number

required

Price of the ticket.

Example:

12

data.prices.valid_until

string

required

Date until the price will be available.

Example:

"2022-01-01T00:00:00.000Z"

data.prices.quantity

number

required

Max number of tickets that can be purchased with this price.
NOTE: 0 means unlimited.

Example:

0

data.prices.includes

string

required

Content the price includes.

Example:

"1 Drink"

data.prices.additional_info

string

required

Additional info.

Example:

"Only valid before 2:00 am."

data.prices._id

string

Unique identifier for the price.

Example:

"1643064796675"

data.prices.name

string

Name of the price.

Example:

"Early Bird"

data.prices.fee_type

enum<string>

Type of the fee.

Available options:

percentage,

fixed

Example:

"percentage"

data.prices.fee_quantity

number

Quantity of the fee.

Example:

10

data.supplements

object[]

required

Supplements of the ticket rate. Each supplement increases the price of the ticket.

Show child attributes

data.supplements._id

string

Unique identifier for the supplement.

Example:

"1643064796675"

data.supplements.label

string

Label of the supplement.

Example:

"1 Copa"

data.supplements.price

number

Price of the supplement.

Example:

12

data.supplements.has_fake_price

boolean

If the supplement has a fake price.

Example:

false

data.supplements.fake_price

number

Fake price of the supplement.

Example:

15

data.available

boolean

required

If the ticket rate is available.

Example:

true

data.availability

object

required

Show child attributes

data.availability.sold

number

Number of tickets sold by the channel.

Example:

10

data.availability.available

number

Number of tickets available to buy.

Example:

90

data.min

number

required

Minimum number of tickets that can be purchased in a single order.

Example:

1

data.max

number

required

Maximum number of tickets that can be purchased in a single order.

Example:

10

data.questions

object[]

required

Questions of the ticket rate.

Show child attributes

data.questions._id

string

required

Unique identifier for the question.

Example:

"1643064796675"

data.questions.label

string

required

Label of the question.

Example:

"¿How did you hear about us?"

data.questions.type

enum<string>

required

Available options:

text,

dropdown

Example:

"dropdown"

data.questions.required

boolean

required

If the question is required.

Example:

true

data.questions.items

string[]

Options of the question.

Example:

["Instagram", "Appear"]

data._id

string

Ticket rate unique identifier.

Example:

"abcdefghi1234567890"

data.show_all_prices

boolean

If the ticket rate is configured to show all prices.

Example:

true

data.current_price

object

Current price available of the ticket rate.

Show child attributes

data.current_price.price

number

required

Price of the ticket.

Example:

12

data.current_price.valid_until

string

required

Date until the price will be available.

Example:

"2022-01-01T00:00:00.000Z"

data.current_price.quantity

number

required

Max number of tickets that can be purchased with this price.
NOTE: 0 means unlimited.

Example:

0

data.current_price.includes

string

required

Content the price includes.

Example:

"1 Drink"

data.current_price.additional_info

string

required

Additional info.

Example:

"Only valid before 2:00 am."

data.current_price._id

string

Unique identifier for the price.

Example:

"1643064796675"

data.current_price.name

string

Name of the price.

Example:

"Early Bird"

data.current_price.fee_type

enum<string>

Type of the fee.

Available options:

percentage,

fixed

Example:

"percentage"

data.current_price.fee_quantity

number

Quantity of the fee.

Example:

10

data.warranty

object

Show child attributes

data.warranty.enabled

boolean

If the warranty is enabled.

Example:

true

data.warranty.percentage

number

Cost of the warranty (applying the percentage to the final price of the ticket).

Example:

20

data.warranty.hours

number

Hours before the event the warranty can be used.

Example:

12

success

boolean

Get a payment by id Get ticket rate by id

⌘I

Introduction

API Reference

Webhooks

Recipes

Get all ticket rates

Authorizations

Query Parameters

Response