Show Client Package Info [Alpha]

Overview

Retrieve detailed information for a specific client package (a package subscription assigned to a client). Returns the package's validity dates, pricing, active status, and booking credit balances showing how many credits have been used vs. remaining.

Authentication

Available for Staff, Directory, and App tokens.

Path Parameters

• uid (required, string) — The unique identifier of the client package to retrieve (e.g., "m73jkvg4bf2z71b2").

Key Response Fields

• active — Whether the package is currently active (within validity dates and has remaining credits).
• valid_from / valid_until — The date range during which this client package is valid. A package is "about to expire" when valid_until is in the near future.
• booking_credits — Array of credit pools, each with total_bookings (total credits) and bookings_usage (credits consumed). Remaining credits = total_bookings - bookings_usage.
• package_id — Reference to the catalog package template this was created from.
• client_id — The client who owns this package subscription.

Notes

• This returns a client-specific subscription, not the catalog template. For the catalog template, use GET /platform/v1/payment/packages/{package_id}.
• This endpoint is in Alpha and may change.