GET/v1/customers/{external_id}/usage/holds/{hold_id}

Get a usage hold

Returns a hold and its state; an open hold past its expiry reads as expired. Needs usage:read.

curl 'https://api.entitler.co/v1/customers/ada/usage/holds/<hold_id>' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string	The customer's external ID, or `me` for the customer a customer token or identity token names.
`hold_id`required	string

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string

Responses

`200`The GetHoldResponse message.

GetHoldResponse

holdHold
- amountintegerrequired
  at least 0; at most 18446744073709552000
- createdAtMsintegerrequired
  at least 0; at most 18446744073709552000
- currencystringrequired
- decimalsinteger (int64)required
  at least 0; at most 4294967295
- expiresAtMsintegerrequired
  at least 0; at most 18446744073709552000
- externalIdstringrequired
- featureKeystringrequired
- idstringrequired
- memberExternalIdstring
- memberIdstring
- settledAmountinteger
  at least 0; at most 18446744073709552000
- stateHoldStaterequired
  One of HOLD_STATE_UNSPECIFIED, HOLD_STATE_OPEN, HOLD_STATE_EXPIRED, HOLD_STATE_SETTLED, HOLD_STATE_RELEASED.
- usageIdstring
- zonestring

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired