---
title: "Create an add-on"
method: POST
path: "/api/v1/add_ons"
tags: ["Add-Ons"]
---

# Create an add-on

`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`

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`

## Headers

- `Api-Key` string, required

## Request body

- object
  - `add_on_category_id` integer, required: ID of the parent add-on category this add-on belongs to
  - `name` string, required: The name of the add-on (e.g., "Uplighting Package")
  - `description` string, 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
  - `price` number: Flat-rate price in dollars (used when price_method is flat_rate)
  - `hourly_price` number: Per-hour price in dollars (used when price_method is hourly)
  - `daily_price` number: Per-day price in dollars (used when price_method is daily)
  - `taxable` boolean: Whether the add-on is taxable
  - `maximum_quantity` integer: Maximum quantity a customer can book (must be >= 1)
  - `multiply_by_number_of_units` boolean: Multiply the price by the quantity booked
  - `visible_on_widget` boolean: Whether the add-on is shown on the booking widget
  - `adds_minutes_to_event_length` boolean: Whether booking this add-on extends the event length
  - `minutes_to_be_added_to_event_length` integer: Minutes added to the event length when adds_minutes_to_event_length is true
  - `requires_lead_time` boolean: Whether the add-on requires advance lead time to book
  - `lead_time_days` integer: Required lead time in days (when requires_lead_time is true)
  - `video_url` string: YouTube URL for a demo video of the add-on

## Response `200`

add-on created

---

[API](https://skmtc.dev/checkcherry/apis/check-cherry-business-api.md) · [All operations](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/llms.txt) · [OpenAPI document](https://skmtc.dev/checkcherry/apis/check-cherry-business-api/revisions/84a9aabdf519?raw)