Update a ReserveHold Preview

POST / v1 / reserve / holds /:id

Update a ReserveHold’s release schedule or metadata.

Parameters

id string Required The identifier of the ReserveHold to update.
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.
release _ schedule object Configure when to release the ReserveHold.

Returns

Returns the updated ReserveHold object.

cURL

Response

{ "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "object": "reserve.hold", "amount": 1000, "amount_releasable": 1000, "created": 1753380387, "created_by": "application", "currency": "usd", "is_releasable": true, "livemode": false, "metadata": { "test_key": "test_value" }, "reason": "standalone", "release_schedule": { "release_after": 1758588150, "scheduled_release": 1758672000 }, "reserve_plan": null, "source_charge": null, "source_type": "card"}

Retrieve a ReserveHold Preview

GET / v1 / reserve / holds /:id

Retrieve a ReserveHold.

Parameters

id string Required The identifier of the ReserveHold to retrieve.

Returns

Returns a ReserveHold object.

Response

{ "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "object": "reserve.hold", "amount": 1000, "amount_releasable": 1000, "created": 1753380387, "created_by": "application", "currency": "usd", "is_releasable": true, "livemode": false, "metadata": {}, "reason": "standalone", "release_schedule": { "release_after": 1755972386, "scheduled_release": 1755993600 }, "reserve_plan": null, "source_charge": null, "source_type": "card"}

List ReserveHolds Preview

GET / v1 / reserve / holds

Returns a list of ReserveHolds previously created. The ReserveHolds are returned in sorted order, with the most recent ReserveHolds appearing first.

Parameters

currency enum Only return ReserveHolds associated with the currency specified by this currency code. Three-letter ISO currency code, in lowercase. Must be a supported currency.
is _ releasable boolean Only return ReserveHolds that are releasable.
reserve _ plan string Only return ReserveHolds associated with the ReservePlan specified by this ReservePlan ID.
reserve _ release string Only return ReserveHolds associated with the ReserveRelease specified by this ReserveRelease ID.
source _ charge string Only return ReserveHolds associated with the Charge specified by this source charge ID.

More parameters

ending _ before string
limit integer
starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit ReserveHolds, starting after ReserveHold starting_after and ending before ReserveHold ending_before. Each entry in the array is a separate ReserveHold object. If no more ReserveHolds are available, the resulting array will be empty.

Response