Skip to main content
POST
settle a hold with the actual amount

Authorizations

Authorization
string
header
required

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

Body

application/json

The settle 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"

amount
string
required

Final usage after work has stopped. Must not exceed the authorized amount. Settlement returns the unused reservation. An amount above the reservation returns 409 and leaves the hold unchanged.

Pattern: ^\d{1,19}(\.\d{1,8})?$
Example:

"0.05"

Response

The settlement

holdId
string
required

The hold, as returned by authorize

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

"h_42"

actual
string
required

The amount settled

released
string
required

The unused part of the hold, returned

expired
boolean
required

Settled at or after the hold's expiresAt

crossed
string[]
required

Limit ids whose consumed amount first exceeded the limit's amount. A hard limit crosses only after recorded usage took its room. Reservations do not trigger crossings. Replays preserve the original result.

replayed
boolean
required

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

balance
object
required