Create a ReservePlan Preview

POST / v1 / reserve / plans

Create a ReservePlan for a given account of a given type.

Parameters

• percent integer Required The percentage of each Charge to reserve.
• type enum Required The type of the ReservePlan. Possible enum values fixed_release The ReservePlan releases funds after a fixed duration. rolling_release The ReservePlan releases funds on a rolling basis.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency. Leave unset to create a ReservePlan for all currencies.
• 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.
• rolling _ release object How long to hold reserves for a rolling release ReservePlan.

Returns

Returns a ReservePlan object.

cURL

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"}

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"}