Add-Ons

Create an add-on

Creates a new add-on within an add-on category. Add-ons are optional upgrades or equipment customers can add to a booking.

The add_on_category_id of the parent category is required, along with a name and a description. Pricing defaults to a flat rate of 0 — set price_method and the matching price field to charge for it. New add-ons are appended to the end of the category.

Required permission: offerings_write

post/api/v1/add_ons

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/add_ons
  • Auth: none declared. Required headers: Api-Key

Headers

Api-Keystring required

Your Integration Key

Request body

add_on_category_idinteger required

ID of the parent add-on category this add-on belongs to

namestring required

The name of the add-on (e.g., "Uplighting Package")

descriptionstring required

Customer-facing description of the add-on

status'Active' | 'Archived'

Whether the add-on is active or archived

price_method'flat_rate' | 'hourly' | 'daily'

How the add-on is priced

pricenumber

Flat-rate price in dollars (used when price_method is flat_rate)

hourly_pricenumber

Per-hour price in dollars (used when price_method is hourly)

daily_pricenumber

Per-day price in dollars (used when price_method is daily)

taxableboolean

Whether the add-on is taxable

maximum_quantityinteger

Maximum quantity a customer can book (must be >= 1)

multiply_by_number_of_unitsboolean

Multiply the price by the quantity booked

visible_on_widgetboolean

Whether the add-on is shown on the booking widget

adds_minutes_to_event_lengthboolean

Whether booking this add-on extends the event length

minutes_to_be_added_to_event_lengthinteger

Minutes added to the event length when adds_minutes_to_event_length is true

requires_lead_timeboolean

Whether the add-on requires advance lead time to book

lead_time_daysinteger

Required lead time in days (when requires_lead_time is true)

video_urlstring

YouTube URL for a demo video of the add-on

Response

add-on created

Changes

No recorded changes to this operation across all 2 revisions of this API.