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 ReserveHold object Preview

Reserves
Reserve Holds
The ReserveHold object

Attributes

  • idstring

    Unique identifier for the object.

  • amountinteger

    Amount reserved. A positive integer representing how much is reserved in the smallest currency unit.

  • currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

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

  • release_scheduleobject

    Information about the release schedule of the ReserveHold.

    • release_schedule.release_afternullable timestamp

      The time after which the ReserveHold is requested to be released.

    • release_schedule.scheduled_releasenullable timestamp

      The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after release_after.

More attributes

  • objectstring

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

  • amount_releasablenullable integerConnect Only

    Amount in cents that can be released from this ReserveHold

  • createdtimestamp

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

  • created_byenum

    Indicates which party created this ReserveHold.

    Possible enum values
    application

    The object was created by an application.

    stripe

    The object was created by Stripe.

  • is_releasablenullable booleanConnect Only

    Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven’t been fully released yet.

  • livemodeboolean

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

  • reasonenum

    The reason for the ReserveHold.

    Possible enum values
    charge

    The ReserveHold was automatically created on pay-in based on an active ReservePlan.

    standalone

    The ReserveHold was created by an API call and is not associated with a charge.

  • reserve_plannullable stringExpandable

    The ReservePlan which produced this ReserveHold (i.e., resplan_123)

  • source_chargenullable stringExpandable

    The Charge which funded this ReserveHold (e.g., ch_123)

  • source_typeenum

    Which balance this ReserveHold is reserving funds from.

The ReserveHold object
{
  "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW",
  "object": "reserve.hold",
  "amount": 1000,
  "amount_releasable": 1000,
  "created": 1753380387,
  "created_by": "application",
  "currency": "usd",
  "is_releasable": true,
  "livemode": false,
  "metadata": {},
  "reason": "standalone",
  "release_schedule": {
    "release_after": 1755972386,
    "scheduled_release": 1755993600
  },
  "reserve_plan": null,
  "source_charge": null,
  "source_type": "card"
}