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}

List ReserveReleases Preview

GET / v1 / reserve / releases

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

Parameters

currency enum Only return ReserveReleases associated with the currency specified by this currency code. Three-letter ISO currency code, in lowercase. Must be a supported currency.
reserve _ hold string Only return ReserveReleases associated with the ReserveHold specified by this ReserveHold ID.
reserve _ plan string Only return ReserveReleases associated with the ReservePlan specified by this ReservePlan 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 ReserveReleases, starting after ReserveRelease starting_after and ending before ReserveRelease ending_before. Each entry in the array is a separate ReserveRelease object. If no more ReserveReleases are available, the resulting array will be empty.

Response