Skip to main content
POST
Close a retainer pack

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Retainer pack ID

Body

application/json
refund_amount
number

Money returned to the client for unclaimed retainers. Recorded as an adjustment on the pack; at most the net retained amount.

refund_comment
string | null

Note on the refund, at most 500 characters.

Maximum string length: 500
refund_date
string<date> | null

Date of the refund (YYYY-MM-DD). Defaults to today.

Response

Retainer pack closed

success
enum<boolean>
required
Available options:
true
data
object
required