Update a ReservePlan Preview
POST / v1 / reserve / plans /:id
Update a ReservePlan’s configuration, percentage, or metadata.
Parameters
- id string Required The identifier of the ReservePlan to update.
- fixed _ release object When to release all funds for a fixed release ReservePlan.
- 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. - percent integer The percentage of each Charge to reserve.
- rolling _ release object How long to hold reserves for a rolling release ReservePlan.
Returns
Returns the updated ReservePlan object.
cURL
Response
{ "id": "resplan_61SxxwCbZ70gJfcoy41Q8rCFhzAUW", "object": "reserve.plan", "created": 1753405164, "created_by": "application", "currency": "usd", "disabled_at": null, "livemode": false, "metadata": { "test_key": "test_value" }, "percent": 20, "rolling_release": { "days_after_charge": 40, "expires_on": 1755997675 }, "status": "active", "type": "rolling_release"}
Retrieve a ReservePlan Preview
GET / v1 / reserve / plans /:id
Retrieve a ReservePlan.
Parameters
- id string Required The identifier of the ReservePlan to retrieve.
Returns
Returns a ReservePlan object.
Response
{ "id": "resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW", "object": "reserve.plan", "created": 1753380438, "created_by": "application", "currency": "usd", "disabled_at": null, "livemode": false, "metadata": {}, "percent": 15, "rolling_release": { "days_after_charge": 30, "expires_on": 1755972438 }, "status": "active", "type": "rolling_release"}
List ReservePlans Preview
GET / v1 / reserve / plans
Returns a list of ReservePlans previously created. The ReservePlans are returned in sorted order, with the most recent ReservePlans appearing first.
Parameters
No parameters.
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 ReservePlans, starting after ReservePlan starting_after and ending before ReservePlan ending_before. Each entry in the array is a separate ReservePlan object. If no more ReservePlans are available, the resulting array will be empty.
cURL
Response