Create a ReserveRelease Preview

Reserves
Reserve Releases
Create a ReserveRelease

Create a ReserveRelease.

Parameters

  • reserve_holdstringRequired

    The ReserveHold to release.

  • amountinteger

    Amount to be released from the provided ReserveHold. A positive integer representing how much to release in the smallest currency unit (e.g., 100 cents to release $1.00 or 100 to release ¥100, a zero-decimal currency). If not provided, the full releasable amount of the ReserveHold will be released.

  • currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns a ReserveRelease object.

POST /v1/reserve/releases
curl https://api.stripe.com/v1/reserve/releases \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
-d reserve_hold=reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW \
-d amount=500 \
-d currency=usd
Response
{
"id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW",
"object": "reserve.release",
"amount": 500,
"created": 1753406491,
"created_by": "application",
"currency": "usd",
"livemode": false,
"metadata": {},
"reason": "hold_released_early",
"released_at": 1753406491,
"reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW",
"reserve_plan": null
}