Update client package [Alpha]

Overview

Update an existing client package subscription. Allows extending the validity period and adjusting credit allocations for the package's booking credits.

Authentication

Available for Staff, Directory, and App tokens.

Path Parameters

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

Updatable Fields

• valid_until (string, ISO 8601 date) — Extend or change the expiration date. Must be in the future and must be on or after valid_from.
• booking_credits (array) — Adjust credit allocations. Each entry requires:
  • id (string) — The booking credit ID to update.
  • total_bookings (integer) — New total credit count. Must be greater than or equal to the current bookings_usage (you cannot reduce credits below what has already been consumed).

Notes

• You cannot change the client, package template, or pricing through this endpoint.
• To fully consume or exhaust a package, set total_bookings equal to bookings_usage on all credits.
• This endpoint is in Alpha and may change.