add-ons.v1

An optional extra that can be added to a booking (e.g., equipment rental, catering).

  • attributes
    Type: object
    • calculation_interval
      Type: string | null

      Calculation interval

    • calculation_unit
      Type: string | null

      Calculation unit

    • currency
      Type: string

      ISO 4217 currency code

    • customer_notice
      Type: string | null

      Notice shown to customers

    • description
      Type: string | null

      Rich text description

    • featured
      Type: boolean

      Whether featured in listing

    • full_refund
      Type: boolean

      Whether fully refundable

    • is_net_price
      Type: boolean

      Whether price is net

    • is_third_party
      Type: boolean

      Whether provided by third party

    • lead_time
      Type: integer

      Lead time in minutes

    • max_quantity
      Type: integer

      Maximum quantity

    • min_quantity
      Type: integer

      Minimum quantity

    • name
      Type: string

      Add-on name

    • plain_description
      Type: string | null

      Plain text description

    • price
      Type: number

      Base price

    • price_type
      Type: stringenum

      Pricing type

      values
      • fixed
      • per_unit
      • staggered
    • staggered_pricing
      Type: array

      Staggered pricing tiers

    • tax_rate
      Type: number

      Tax rate

  • id
    Type: string
  • links
    Type: object · ResourceLinks

    JSON:API self-link object

    • self
      Type: stringFormat: uri
  • relationships
    Type: object
    • cover_image
      Type: object

      Cover image

    • group
      Type: object

      Add-on group

  • type
    Type: string