Fever Plans API

openapi: 3.2.0
info:
  title: Fever - Reporting Plans API
  description: Access detailed event sales data through a reliable REST API.
  contact:
    name: Support
    email: data-support@feverup.com
  version: 1.5.0
  x-logo:
    url: https://res.cloudinary.com/fever/image/upload/ar_16:9,c_mpad,w_425/web/fever-logo-dark.jpg
servers:
- url: /v1
tags:
- name: Plans
  description: 'The goal of the Plan endpoint is to provide all information about the plans/events/experiences/listings organised by a

    partner.'
paths:
  /plans/search:
    post:
      tags:
      - Plans
      summary: Request plans
      description: Create a request to get plans. The field plan_ids can be used to filter the plans by id.If empty, all plans will be returned.The search will be processed asynchronously, being able to fetch the result from the provided search ID.
      operationId: search_plans_plans_search_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: user-id-to-impersonate
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: User id from the user that you want to impersonate
          title: User-Id-To-Impersonate
        description: User id from the user that you want to impersonate
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/PlansParams'
              - type: 'null'
              title: Config
      responses:
        '202':
          description: Request was created successfully but is still running asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchStatus'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: The request timed out. Please try again later
                      example: The request timed out. Please try again later
                      title: Detail
                      type: string
                  title: RequestTimeoutError
                  type: object
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: Server is busy. Please retry your query later
                      example: Server is busy. Please retry your query later
                      title: Detail
                      type: string
                  title: ServerBusyError
                  type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: An internal server error occurred. Please try again later
                      example: An internal server error occurred. Please try again later
                      title: Detail
                      type: string
                  title: InternalServerError
                  type: object
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: bash
        source: "\ncurl -X POST \"https://<HOSTNAME>/v1/plans/search\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n    \"plan_ids\": [\n        123,\n        456\n    ]\n}' \\\n-H \"Authorization: Bearer <YOUR_ACCESS_TOKEN>\"\n            "
        label: curl
      - lang: python
        source: "\nimport requests\n\nhostname = \"<HOSTNAME>\"\nusername = \"<USERNAME>\"\npassword = \"<PASSWORD>\"\n\naccess_token = requests.post(f\"https://{hostname}/v1/auth/token\", data={\"username\": username, \"password\": password}).json()[\"access_token\"]\n\nrequests.post(f\"https://{hostname}/v1/plans/search\",\n    json={\n    \"plan_ids\": [\n        123,\n        456\n    ]\n},\n    headers={\"Authorization\": f\"Bearer {access_token}\"}\n)\n"
        label: Python
  /plans/search/{search_id}:
    get:
      tags:
      - Plans
      summary: Get plans
      description: Get plans from a search_id.
      operationId: get_plans_search_page_plans_search__search_id__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: search_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Search Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Page
      - name: user-id-to-impersonate
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: User id from the user that you want to impersonate
          title: User-Id-To-Impersonate
        description: User id from the user that you want to impersonate
      responses:
        '200':
          description: Search was obtained successfully
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/Search_PlanDimension_PlansParams_-Output'
                - $ref: '#/components/schemas/SearchStatus'
                title: Response Get Plans Search Page Plans Search  Search Id  Get
                $ref: '#/components/schemas/Search_PlanDimension_PlansParams_-Input'
        '202':
          description: Request is still running asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      example: Search 01b571aa-0203-e36d-0000-0d3758abb35d not found.
                      title: Detail
                      type: string
                  required:
                  - detail
                  title: SearchIdNotFoundError
                  type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      example: Search ID 1234 is not valid
                      title: Detail
                      type: string
                  required:
                  - detail
                  title: InvalidSearchIdError
                  type: object
                - properties:
                    detail:
                      example: Invalid partition parameter. The partition must be long type parsable and between 0 and 1, but 2 is specified.
                      title: Detail
                      type: string
                  required:
                  - detail
                  title: InvalidPageIdError
                  type: object
                - properties:
                    detail:
                      example: Response is too large. Please apply filters to reduce its size.
                      title: Detail
                      type: string
                  required:
                  - detail
                  title: ResponseTooLargeError
                  type: object
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: The request timed out. Please try again later
                      example: The request timed out. Please try again later
                      title: Detail
                      type: string
                  title: RequestTimeoutError
                  type: object
        '410':
          description: Search expired
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: Search expired. Please create a new one
                      example: Search expired. Please create a new one
                      title: Detail
                      type: string
                  title: SearchExpiredError
                  type: object
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: Server is busy. Please retry your query later
                      example: Server is busy. Please retry your query later
                      title: Detail
                      type: string
                  title: ServerBusyError
                  type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    detail:
                      default: An internal server error occurred. Please try again later
                      example: An internal server error occurred. Please try again later
                      title: Detail
                      type: string
                  title: InternalServerError
                  type: object
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: bash
        source: '

          curl -X GET "https://<HOSTNAME>/v1/plans/search/<SEARCH_ID>?page=0" \

          -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

          '
        label: curl
      - lang: python
        source: "\nimport requests\n\nhostname = \"<HOSTNAME>\"\nusername = \"<USERNAME>\"\npassword = \"<PASSWORD>\"\n\naccess_token = requests.post(f\"https://{hostname}/v1/auth/token\", data={\"username\": username, \"password\": password}).json()[\"access_token\"]\n\nrequests.get(f\"https://{hostname}/v1/plans/search/<SEARCH_ID>\",\n    params={'page': 0},\n    headers={\"Authorization\": f\"Bearer {access_token}\"}\n)\n"
        label: Python
components:
  schemas:
    GalleryResourceType:
      type: string
      enum:
      - image
      - video
      title: GalleryResourceType
    Search_PlanDimension_PlansParams_-Output:
      properties:
        partition_info:
          anyOf:
          - items:
              $ref: '#/components/schemas/PartitionInfo'
            type: array
          - type: 'null'
          title: Partition Info
          description: Partition information
        params:
          anyOf:
          - $ref: '#/components/schemas/PlansParams'
          - type: 'null'
          description: Parameters used in the search
        data:
          items:
            $ref: '#/components/schemas/PlanDimension-Output'
          type: array
          title: Data
          description: Data rows
      type: object
      required:
      - data
      title: Search[PlanDimension, PlansParams]
    Venue:
      properties:
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: Venue city
          example: New York
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: Venue country
          example: USA
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Venue name
          example: Madison Square Garden
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          description: Venue timezone
          example: America/New_York
      type: object
      title: Venue
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PlanDimension-Output:
      properties:
        id:
          type: integer
          title: Id
          description: Plan ID
          example: 1234
        gallery:
          anyOf:
          - items:
              $ref: '#/components/schemas/GalleryResource'
            type: array
          - type: 'null'
          title: Gallery
          description: List of gallery resources attached to the plan
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Plan name
          example: Plan name
        taxonomies:
          anyOf:
          - items:
              $ref: '#/components/schemas/Taxonomy'
            type: array
          - type: 'null'
          title: Taxonomies
          description: List of taxonomies attached to the plan
        partner_id:
          type: integer
          title: Partner Id
          description: Partner ID
          example: 1234
        partner_name:
          type: string
          title: Partner Name
          description: Partner name
          example: Partner name
        currency:
          anyOf:
          - $ref: '#/components/schemas/Currency'
          - type: 'null'
          description: Plan currency
          example: USD
        sessions:
          anyOf:
          - items:
              $ref: '#/components/schemas/SessionDimension'
            type: array
          - type: 'null'
          title: Sessions
          description: List of sessions attached to the plan
          deprecated: true
        is_wait_list:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Wait List
          description: Indicates if the plan is a wait list
          example: true
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: City name
          example: City name
        state:
          anyOf:
          - type: string
          - type: 'null'
          title: State
          description: State name
          example: State name
        venue:
          anyOf:
          - type: string
          - type: 'null'
          title: Venue
          description: Venue name
          example: Venue name
        slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Slug
          description: Plan slug, used to build the URL
          example: plan-description
        external_provider:
          anyOf:
          - $ref: '#/components/schemas/ExternalProvider'
          - type: 'null'
          description: External provider attached to the plan
      type: object
      required:
      - id
      - partner_id
      - partner_name
      title: PlanDimension
    PartitionInfo:
      properties:
        partition_num:
          type: integer
          minimum: 0.0
          title: Partition Num
          description: Partition number
          example: 0
        endpoint:
          type: string
          title: Endpoint
          description: Endpoint to fetch data for partition
          example: /01b26479-0203-63c9-0000-d37572ae91ea?page=0
        size:
          type: integer
          minimum: 0.0
          title: Size
          description: Partition size in bytes
          example: 15058
        rows:
          type: integer
          minimum: 0.0
          title: Rows
          description: Number of rows contained in partition. One row represents a single transaction result (e.g. order, plan etc.).
          example: 4099
      type: object
      required:
      - partition_num
      - endpoint
      - size
      - rows
      title: PartitionInfo
      examples:
      - endpoint: /01b26479-0203-63c9-0000-d37572ae91ea?page=0
        partition_num: 0
        rows: 4099
        size: 15058
      - endpoint: /01b26479-0203-63c9-0000-d37572ae91ea?page=1
        partition_num: 1
        rows: 3145
        size: 11260
    SessionDimension:
      properties:
        id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Id
          description: Session ID
          example: 12345
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Session name
          example: Session name
        available_tickets:
          anyOf:
          - type: integer
          - type: 'null'
          title: Available Tickets
          description: Session available tickets. This field is always null if the session is a wait list.
          example: 10
        capacity:
          anyOf:
          - type: integer
          - type: 'null'
          title: Capacity
          description: Session capacity. This field is always null if the session is a wait list.
          example: 100
        end_date_utc:
          anyOf:
          - type: string
          - type: 'null'
          title: End Date Utc
          description: Session end date
          example: '2023-12-18 08:30:27.789 Z'
        first_purchasable_date_utc:
          anyOf:
          - type: string
          - type: 'null'
          title: First Purchasable Date Utc
          description: Session first purchasable date
          example: '2023-12-18'
        is_addon:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Addon
          description: Is the session an addon
          example: false
        is_shop_product:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Shop Product
          description: Is the session a shop product
          example: false
        is_wait_list:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Wait List
          description: Is the session a wait list. Deprecated, since now the waitlist flag is configured at plan level
          deprecated: true
          example: false
        start_date_utc:
          anyOf:
          - type: string
          - type: 'null'
          title: Start Date Utc
          description: Session start date
          example: '2023-12-18 08:30:27.789 Z'
        venue:
          anyOf:
          - $ref: '#/components/schemas/Venue'
          - type: 'null'
          description: Session venue
        timeslot_capacity:
          anyOf:
          - type: integer
          - type: 'null'
          title: Timeslot Capacity
          description: Total timeslot capacity. Null for waitlist plans or anytime plans.
          example: 578
        plan_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Plan Id
          description: Plan ID
          example: 12345
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
          description: Session tags
          example: []
        ticket_price:
          anyOf:
          - type: number
          - type: 'null'
          title: Ticket Price
          description: Session ticket price
          example: 10.0
        ticket_price_tax_base:
          anyOf:
          - type: number
          - type: 'null'
          title: Ticket Price Tax Base
          description: Session ticket price tax base
          example: 8.0
        surcharge_per_ticket:
          anyOf:
          - type: number
          - type: 'null'
          title: Surcharge Per Ticket
          description: Session surcharge per ticket
          example: 2.0
        surcharge_per_ticket_tax_base:
          anyOf:
          - type: number
          - type: 'null'
          title: Surcharge Per Ticket Tax Base
          description: Session surcharge per ticket tax base
          example: 0.5
        session_type_id:
          type: integer
          title: Session Type Id
          description: Fever session-type identifier. Join key for /reports/entitlements.
          example: 88123
        product_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Product Type
          description: Session product type. Null when the session has no associated session type.
          example: TIMED_ENTRY
        customer_profile:
          anyOf:
          - type: string
          - type: 'null'
          title: Customer Profile
          description: Target customer profile of the session. Null when the session has no associated session type.
          example: ADULT
        group_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Group Name
          description: Name of the session type group. Null when the session type has no associated group.
          example: General Admission
      type: object
      required:
      - id
      - session_type_id
      title: SessionDimension
    GalleryResource:
      properties:
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
          description: Gallery resource URL
          example: https://www.example.com/image.jpg
        type:
          $ref: '#/components/schemas/GalleryResourceType'
          description: Gallery resource type (image or video)
          example: image
      type: object
      required:
      - type
      title: GalleryResource
    ExternalProvider:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: External provider name
          example: external_provider
        plan_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Plan Id
          description: External provider plan ID
          example: 1234
        session_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Session Id
          description: External provider session ID
          example: 1234
      type: object
      title: ExternalProvider
    Currency:
      type: string
      enum:
      - AED
      - ARS
      - AUD
      - BGN
      - BRL
      - CAD
      - CHF
      - CLP
      - COP
      - CRC
      - CZK
      - DKK
      - EUR
      - GBP
      - HKD
      - HUF
      - INR
      - JPY
      - KRW
      - MAD
      - MXN
      - MYR
      - NOK
      - NZD
      - PLN
      - QAR
      - RON
      - RUB
      - SAR
      - SEK
      - SGD
      - USD
      - ZAR
      title: Currency
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Taxonomy:
      properties:
        id:
          type: integer
          title: Id
          description: Taxonomy ID
          example: 1234
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Taxonomy name
          example: Taxonomy name
      type: object
      required:
      - id
      title: Taxonomy
    PlanDimension-Input:
      properties:
        id:
          type: integer
          title: Id
          description: Plan ID
          example: 1234
        gallery:
          anyOf:
          - items:
              $ref: '#/components/schemas/GalleryResource'
            type: array
          - type: 'null'
          title: Gallery
          description: List of gallery resources attached to the plan
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Plan name
          example: Plan name
        taxonomies:
          anyOf:
          - items:
              $ref: '#/components/schemas/Taxonomy'
            type: array
          - type: 'null'
          title: Taxonomies
          description: List of taxonomies attached to the plan
        partner_id:
          type: integer
          title: Partner Id
          description: Partner ID
          example: 1234
        partner_name:
          type: string
          title: Partner Name
          description: Partner name
          example: Partner name
        currency:
          anyOf:
          - $ref: '#/components/schemas/Currency'
          - type: 'null'
          description: Plan currency
          example: USD
        sessions:
          anyOf:
          - items:
              $ref: '#/components/schemas/SessionDimension'
            type: array
          - type: 'null'
          title: Sessions
          description: List of sessions attached to the plan
          deprecated: true
        is_wait_list:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Wait List
          description: Indicates if the plan is a wait list
          example: true
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: City name
          example: City name
        state:
          anyOf:
          - type: string
          - type: 'null'
          title: State
          description: State name
          example: State name
        venue:
          anyOf:
          - type: string
          - type: 'null'
          title: Venue
          description: Venue name
          example: Venue name
        slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Slug
          description: Plan slug, used to build the URL
          example: plan-description
        external_provider:
          anyOf:
          - $ref: '#/components/schemas/ExternalProvider'
          - type: 'null'
          description: External provider attached to the plan
      type: object
      required:
      - id
      - partner_id
      - partner_name
      title: PlanDimension
    SearchStatus:
      properties:
        message:
          type: string
          title: Message
          description: Message about the search status
          example: Asynchronous execution in progress. Use provided query id to perform query monitoring and management.
        search_id:
          type: string
          format: uuid
          title: Search Id
          description: The search ID
          example: b59d4093-cbfc-4a1d-be5c-ba78d4ffbc64
      type: object
      required:
      - message
      - search_id
      title: SearchStatus
    PlansParams:
      properties:
        plan_ids:
          anyOf:
          - items:
              type: integer
            type: array
            maxItems: 1000
          - type: 'null'
          title: Plan Ids
          description: List of ids of the plans to filter by.
          default: []
          examples:
          - []
          - - 123
          - - 123
            - 456
      additionalProperties: false
      type: object
      title: PlansParams
    Search_PlanDimension_PlansParams_-Input:
      properties:
        partition_info:
          anyOf:
          - items:
              $ref: '#/components/schemas/PartitionInfo'
            type: array
          - type: 'null'
          title: Partition Info
          description: Partition information
        params:
          anyOf:
          - $ref: '#/components/schemas/PlansParams'
          - type: 'null'
          description: Parameters used in the search
        data:
          items:
            $ref: '#/components/schemas/PlanDimension-Input'
          type: array
          title: Data
          description: Data rows
      type: object
      required:
      - data
      title: Search[PlanDimension, PlansParams]
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/auth/token
x-tagGroups:
- name: Endpoints
  tags:
  - Authentication
  - Billing L1
  - Billing L2
  - Carts
  - Channels
  - Customers
  - Customers Mapping
  - Deposits
  - Entitlement Configurations
  - Exchange Rates
  - FeverZone
  - Last Tour
  - Magnati
  - Neon
  - Order Items
  - Order Items Test
  - Order Sales
  - Plan Code Scans
  - Plans
  - Real Time
  - Reservations
  - SailGP
  - Sessions
  - Square
  - Webhooks