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

Create a ReservePlan Preview

Reserves
Reserve Plans
Create a ReservePlan

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

Parameters

  • percentintegerRequired

    The percentage of each Charge to reserve.

  • typeenumRequired

    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.

  • currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency. Leave unset to create a ReservePlan for all currencies.

  • 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.

  • rolling_releaseobject

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

    • rolling_release.days_after_chargeintegerRequired

      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 a ReservePlan object.

POST /v1/reserve/plans
curl https://api.stripe.com/v1/reserve/plans \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
  -d type=rolling_release \
  -d percent=15 \
  -d currency=usd \
  -d "rolling_release[days_after_charge]"=30 \
  -d "rolling_release[expires_on]"=1755972438
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"
}