List of Client Packages

Overview

Retrieve a paginated list of client packages (package subscriptions) for the authenticated client, scoped to a specific matter/conversation. Returns each package's validity dates, credit balances, and active status.

Authentication

Available for Client Tokens only.

Required Parameters

• matter_uid (query, string) — The UID of the matter/conversation to fetch packages for. Client packages are scoped to matters.

Optional Parameters

• page (query, string) — Page number for pagination (default: 1).
• per_page (query, string) — Number of results per page (default: 25).
• sort (query, string) — Sort by one or more fields. Format: field:direction. Available fields: created_at, updated_at, valid_from, valid_until. Directions: asc, desc. Example: sort=valid_until:asc to show soonest-expiring first.
• filter (query, string) — Filter results by state. Format: filter[state][eq]=ACTIVE or filter[state][eq]=INACTIVE. ACTIVE packages have remaining credits and valid dates; INACTIVE packages are expired or fully consumed.

Notes

• "About to expire" packages can be found by sorting by valid_until:asc and checking which packages have valid_until dates in the near future.
• An ACTIVE package has valid_from <= now <= valid_until and at least one booking credit with total_bookings > bookings_usage.