Use Client Package Credit [Alpha]

Overview

Redeem a credit from the authenticated client's active package to pay for an appointment or service session. This marks the associated payment status as paid (price set to $0) and decrements one credit from the client's package. If multiple packages qualify, the soonest-expiring package is used first.

Authentication

Available for Client Tokens only.

Required Parameters

• payment_status_id (string) — The ID of the payment status record to pay using a package credit. Must reference a pending/unpaid payment status linked to an appointment.

Notes

• Returns 422 "There is no package to use" if no active client packages with available credits exist for the relevant service.
• Returns 422 if the payment status is already paid.
• There is also a Staff-facing version at POST /platform/v1/payment/client_packages/update_usage that accepts Staff tokens (and Directory/App tokens with the X-On-Behalf-Of header).
• This endpoint is in Alpha and may change.