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

The ReservePlan object Preview

Reserves
Reserve Plans
The ReservePlan object

Attributes

  • idstring

    Unique identifier for the object.

  • currencynullable 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_releasenullable object

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

    • fixed_release.release_afterinteger

      The time after which all reserved funds are requested to be released.

    • fixed_release.scheduled_releasetimestamp

      The time at which reserved funds are scheduled to be released, automatically set to midnight UTC of the day after release_after.

  • metadatanullable object

    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.

  • percentinteger

    The percent of each Charge to reserve.

  • rolling_releasenullable object

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

    • rolling_release.days_after_chargeinteger

      The number of days funds will be reserved for before release.

    • rolling_release.expires_onnullable integer

      The time at which the ReservePlan will expire.

  • statusenum

    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.

    disabling

    The ReservePlan is in the process of being disabled, and its associated funds are being released.

    expired

    The ReservePlan has expired automatically and is no longer reserving funds, and its associated funds have been released.

  • typeenum

    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

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • created_byenum

    Indicates which party created this ReservePlan.

    Possible enum values
    application

    The object was created by an application.

    stripe

    The object was created by Stripe.

  • disabled_atnullable timestamp

    Time at which the ReservePlan was disabled.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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