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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The UID of the client to assign the package to (e.g., "9yxsdkr1hdjtocpv").

string
required

The UID of the package catalog entry to assign (e.g., "v2fvy50p8gjuvnvb"). Must reference an active package created via POST /platform/v1/payment/packages.

date

Start date in YYYY-MM-DD format (e.g., "2026-03-21"). Defaults to today when omitted.

date

End date in YYYY-MM-DD format (e.g., "2026-04-21"). Defaults based on the package's configured expiration period when omitted.

number

Custom price override for this client package (e.g., 120). When omitted, the package's catalog price is used.

string

Matter/conversation UID to associate with this client package (e.g., "war7ow99zh14qlty").

tax_uids
array of strings

Array of tax UIDs to apply to the client package.

tax_uids
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json