Create a ReserveRelease Preview
POST / v1 / reserve / releases
Create a ReserveRelease to manually release funds from a ReserveHold.
Parameters
- reserve _ hold string Required The ReserveHold to release.
- amount integer Amount to release 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 is released.
- currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- metadata map 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.
cURL
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}
Update a ReserveRelease Preview
POST / v1 / reserve / releases /:id
Update a ReserveRelease’s metadata.
Parameters
- id string Required The identifier of the ReserveRelease to update.
- metadata map Required 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 the updated ReserveRelease object.
cURL
Response
{ "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW", "object": "reserve.release", "amount": 500, "created": 1753406491, "created_by": "application", "currency": "usd", "livemode": false, "metadata": { "test_key": "test_value" }, "reason": "hold_released_early", "released_at": 1753406491, "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "reserve_plan": null}
Retrieve a ReserveRelease Preview
GET / v1 / reserve / releases /:id
Retrieve a ReserveRelease.
Parameters
- id string Required The identifier of the ReserveRelease to retrieve.
Returns
Returns a ReserveRelease object.
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}