Reserve Plans Preview

ReservePlans are used to automatically place holds on a merchant’s funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).

Was this section helpful? Yes No

Create a ReservePlan

POST / v1 / reserve / plans

Update a ReservePlan

POST / v1 / reserve / plans /:id

Retrieve a ReservePlan

GET / v1 / reserve / plans /:id

List ReservePlans

GET / v1 / reserve / plans

Disable a ReservePlan

POST / v1 / reserve / plans /:id / disable

The ReservePlan object Preview

Attributes

• id string Unique identifier for the object.
• currency nullable enum Three-letter ISO currency code, in lowercase. Must be a supported currency. An unset currency indicates that the plan applies to all currencies.
• fixed _ release nullable object When to release all funds for a fixed release plan.
• metadata nullable map Connect Only 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.
• percent integer The percent of each Charge to reserve.
• rolling _ release nullable object How long to hold reserves for a rolling release plan.
• status enum The current status of the ReservePlan. The ReservePlan only affects charges if it is active. Possible enum values active The ReservePlan is active and reserving funds. disabled The ReservePlan has been manually disabled and is no longer reserving funds, and its associated funds have been released. expired The ReservePlan has expired automatically and is no longer reserving funds, and its associated funds have been released.
• type enum 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.

More attributes

• object string, value is "reserve.plan"
• created timestamp
• created _ by enum
• disabled _ at nullable timestamp
• livemode boolean

The ReservePlan object

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

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