Skip to main content
POST
release a hold without consuming

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The release request

key
string
required

The budget's key, chosen by you and unique within the project. Up to 128 letters, digits, and : / _ . @ -, starting with a letter or digit.

Pattern: ^[A-Za-z0-9][A-Za-z0-9:/_.@-]{0,127}$
Example:

"customer:acme"

holdId
string
required

The hold, as returned by authorize

Pattern: ^h_[1-9][0-9]{0,15}$
Example:

"h_42"

Response

The release

holdId
string
required

The hold, as returned by authorize

Pattern: ^h_[1-9][0-9]{0,15}$
Example:

"h_42"

released
string
required

The amount returned: the whole hold

replayed
boolean
required

True when this answer replays an earlier request instead of applying it again

balance
object
required