Skip to navigation
API ReferenceCredits and holdsHolds

Retrieve a hold

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

hold_idstringRequired

The hold ID (hold_...).

Response

The hold.
idstring
object"hold"
customerstring
statusenum

active reserves. captured was used by track(), and for an outcome the reservation moves to the outcome charge. released was let go by you or by track(). expired lapsed and was released automatically.

Allowed values:
amountstring
The current total held, as a decimal string.
captured_amountstring

How much track() has captured so far.

expires_atdatetime
livemodeboolean
created_atdatetime
credit_typestringOptional
currencystringOptional
event_namestringOptional
outcome_definitionstringOptional
agent_idstringOptional
member_idstringOptional
team_idstringOptional
run_idstringOptional
captured_atdatetimeOptional
released_atdatetimeOptional
metadatamap from strings to stringsOptional
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error