About the Add-Ons API

The Add-ons API allows you to manage add-ons for business offerings such as Bookings services. Add-ons are optional extras that extend offerings with additional features or longer duration for an extra cost. For example, you might offer a "yoga mat rental" for a fitness class or a "10-minute extension" for a massage appointment.

Tip: While this API is currently focused on Bookings services, it's built with a generic architecture that can support other business domains. For now, all documentation and sample flows are Bookings-specific. If you're working with store products, consider using the Stores Customizations API instead.

With the Add-ons API, you can:

  • Create and manage add-ons.
  • Query and filter add-ons.
  • Perform bulk operations on multiple add-ons simultaneously.

Before you begin

It's important to note the following points before starting to code when using the Add-Ons API with Bookings services, :

  • Add-ons must be organized into add-on groups before customers can select them during booking.
  • Add-ons can be reused across multiple groups, but each group belongs to only 1 service.

Use cases

Terminology

  • Add-on: An optional extra that extends a business offering such as a Bookings service for an extra cost. Add-ons are either duration-based or quantity-based. When used with Bookings services, add-ons must be included in groups before customers can select them.
  • Duration-based add-on: An add-on that extends the duration of the business offering, specified in minutes. For example, a 10-minute extension for a massage session.
  • Quantity-based add-on: An add-on that customers can purchase in multiple units up to a maximum quantity per add-on. For example, an equipment rental or product purchase.
  • Add-on group: A collection of related add-ons linked to a booking service, managed through the Services V2 API. Groups define the maximum number of different add-ons customers can select from the group and include customer-facing information like prompts and display order.

For a comprehensive glossary of Wix Bookings terms, see Terminology.

Did this help?