Overview

Retrieve a list of package catalog templates for the business. A package is a reusable template that defines a bundle of services and/or products a client can purchase, including pricing, included credits, and a default validity period.

Feature Requirement

Requires the booking_packages feature on the business. It belongs to the Payments module but is not part of every subscription, and is disabled by default on newly provisioned businesses — treat it as unavailable unless you have confirmed it is on for the specific business.

When the feature is off, the request is rejected with 403 Forbidden and this body:

{"message": "403 Forbidden", "status": "module_permission_missing"}

This is an entitlement check, not an authentication or permission failure. It is evaluated before the request body is validated and it fails identically for Staff, Directory and App tokens, so retrying, refreshing the token, or setting X-On-Behalf-Of will not change the outcome. The feature must be enabled for the business first. Related endpoints under /platform/v1/payment/packages and /platform/v1/payment/client_packages share the same gate.

Authentication

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

Query Parameters

• include_items (optional, string) — Pass "true" to include the package items (service/product groups and their credit allocations) in the response. When omitted, items are not returned.
• active_only (optional, string) — Pass "true" to return only active packages (not soft-deleted or deactivated). When omitted, all packages are returned regardless of active state.

Notes

• Packages returned here are catalog templates, not client-assigned subscriptions. To see packages assigned to a specific client, use GET /business/payments/v1/client_packages/{uid} or GET /client/payments/v1/client_packages.
• Each package may contain one or more item groups, each defining a set of services and a total_bookings credit count.