Extras

Update an extra

Updates an existing extra with the provided fields. Only fields included in the request body are modified. Omitted fields remain unchanged.

Use this to rename an extra, change its pricing, toggle widget visibility, or archive it (set status to Archived). To move an extra to a different group, use the move endpoint.

Required permission: offerings_write

put/api/v1/extras/{id}

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/extras/{id}
  • Auth: none declared. Required headers: Api-Key

Path parameters

idinteger required

The unique ID of the extra to update

Headers

Api-Keystring required

Your Integration Key

Request body

namestring

The name of the extra (e.g., "Gold Sequin Backdrop")

descriptionstring

Customer-facing description of the extra

status'Active' | 'Archived'

Whether the extra is active or archived

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

How the extra 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 extra 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 extra is shown on the booking widget

adds_minutes_to_event_lengthboolean

Whether booking this extra 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 extra 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 extra

Response

extra updated

Changes

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