List Packages Info [Alpha]

Overview

Retrieve the list of available package catalog templates for a business, as seen from the client perspective. Returns packages that clients can browse and potentially purchase through the client portal.

Authentication

No authentication required. This is a public endpoint.

Required Parameters

• business_id (query, string) — The UID of the business whose package catalog to retrieve (e.g., "88pzdbz1hmkdoel4"). Must be in UID format, not numeric ID.

Optional Parameters

• page (query, string) — Page number for pagination.
• per_page (query, string) — Number of results per page.
• active_only (query, string) — Pass "true" to return only active packages. When omitted, all packages are returned.

Notes

• This is the client-facing view of the same catalog available to staff via GET /platform/v1/payment/packages.
• Only packages with online_payment_enabled: true are typically shown to clients for self-purchase.
• This endpoint is in Alpha and may change.