Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Update a ReservePlan Preview

Reserves
Reserve Plans
Update a ReservePlan

Update a ReservePlan’s configuration, percentage, or metadata.

Parameters

  • idstringRequired

    The identifier of the ReservePlan to update.

  • fixed_releaseobject

    Configuration specifying when all funds will be released when the ReservePlan is configured for fixed release.

    • fixed_release.release_aftertimestampRequired

      The time after which reserved funds will be released.

  • metadataobject

    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.

  • percentinteger

    The percentage of each Charge to reserve.

  • rolling_releaseobject

    Configuration specifying how long reserves will be held when the ReservePlan is configured for rolling release.

    • rolling_release.days_after_chargeinteger

      The number of days funds will be reserved for.

    • rolling_release.expires_ontimestamp

      Time at which this rolling release ReservePlan will expire. If not set, the ReservePlan will continue indefinitely.

Returns

Returns the updated ReservePlan object.

POST /v1/reserve/plans/:id
curl https://api.stripe.com/v1/reserve/plans/resplan_61SxxwCbZ70gJfcoy41Q8rCFhzAUW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
  -d percent=20 \
  -d "rolling_release[days_after_charge]"=40 \
  -d "rolling_release[expires_on]"=1755997558 \
  -d "metadata[test_key]"=test_value
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"
}