Create Client Package

Overview

Create a Client Package — assigns a payment package to a specific client, creating a subscription-like record with optional validity dates and custom pricing.

Authentication

Available for Staff, App, and Directory tokens.

Required Parameters

  • client_id — the UID of the client who will receive the package.
  • package_id — the UID of the package catalog entry to assign.

Optional Parameters

  • valid_from — start date in YYYY-MM-DD format (defaults to today).
  • valid_until — end date in YYYY-MM-DD format (defaults based on the package's configured expiration).
  • price — custom price override; when omitted the package's catalog price is used.
  • conversation_id — matter/conversation UID to associate with this client package.
  • tax_uids — array of tax UIDs to apply.

Notes

  • The package_id must reference a valid, active package in the business's catalog (created via POST /platform/v1/payment/packages).
  • Returns 422 when the request is invalid or the referenced package does not exist.
Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here!