Update package [Alpha]

Overview

Update an existing package catalog template. You can modify pricing, name, description, expiration settings, items, and active status. Changes to the catalog template do NOT retroactively affect already-created client packages — those retain the values they were assigned at creation.

Authentication

Available for Staff tokens. Directory and App tokens are supported with the X-On-Behalf-Of header set to the target business UID.

Path Parameters

  • package_id (required, string) — The unique identifier (UID) of the catalog package to update (e.g., "v2fvy50p8gjuvnvb").

Request Body

The request body must wrap all fields inside a package object. All fields are optional — only include fields you want to change.

Updatable Fields

  • name, price, currency, description — Basic package information.
  • expiration, expiration_unit — Default validity period for future client subscriptions.
  • discount_amount, discount_unit — Pricing discount.
  • items — Service/product groups. Each item includes services (array of service UIDs) and total_bookings (credit count). When updating items, pass the complete desired items array.
  • online_payment_enabled — Client self-purchase toggle.
  • active — Set to false to deactivate the package (hides from catalog listings).

Notes

  • This endpoint is in Alpha and may change.
  • Deactivating a package (active: false) prevents it from being assigned to new clients but does not affect existing client packages.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier (UID) of the catalog package to update (e.g., "v2fvy50p8gjuvnvb").

Body Params
package
object
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json