Get all package of business

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.

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.