Skip to main content
POST
Release a credit reservation

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

reservationId
string
required

The client-provided reservation ID

Required string length: 1 - 255

Body

application/json

Request body for releasing a credit reservation

customerId
string
required

The customer the reservation was made for

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
currencyId
string
required

The credit currency of the reservation

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
consumedAmount
number
required

The amount of credits to consume at release. Up to the reserved amount is charged to the credits that backed the reservation; the rest returns to the balance, and any amount above the reservation is consumed normally.

Required range: x >= 0
resourceId
string

The resource the reservation was made for, if any

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

The released reservation and the optimistic balance.

Response object

data
ReleaseReservationResponse · object
required

Result of releasing a credit reservation