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

Reserves
Reserve Releases
The ReserveRelease object

Attributes

  • idstring

    Unique identifier for the object.

  • amountinteger

    Amount released. A positive integer representing how much is released 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.

  • reasonenum

    The reason for the ReserveRelease, indicating why the funds were released.

    Possible enum values
    bulk_hold_expiry

    The ReserveHold expired automatically according to its schedule.

    hold_released_early

    The ReserveHold was manually released before its scheduled release.

    hold_reversed

    The ReserveHold was reversed due to a refund or dispute.

    plan_disabled

    The ReserveHold was released due to its associated plan being disabled.

  • released_attimestamp

    The release timestamp of the funds.

  • reserve_holdnullable stringExpandable

    The ReserveHold this ReserveRelease is associated with.

  • source_transactionnullable object

    The transaction which triggered this ReserveRelease.

    • source_transaction.disputenullable stringExpandable

      The ID of the dispute.

    • source_transaction.refundnullable stringExpandable

      The ID of the refund.

    • source_transaction.typeenum

      The type of source transaction.

      Possible enum values
      dispute

      The source transaction is a dispute.

      refund

      The source transaction is a refund.

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

    Possible enum values
    application

    The object was created by an application.

    stripe

    The object was created by Stripe.

  • livemodeboolean

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

  • reserve_plannullable stringExpandable

    The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry.

The ReserveRelease object
{
  "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW",
  "object": "reserve.release",
  "amount": 500,
  "created": 1753406491,
  "created_by": "application",
  "currency": "usd",
  "livemode": false,
  "metadata": {},
  "reason": "hold_released_early",
  "released_at": 1753406491,
  "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW",
  "reserve_plan": null
}