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

Reserves
Reserve Holds
Update a ReserveHold

Update a ReserveHold’s release schedule or metadata.

Parameters

  • idstringRequired

    The identifier of the ReserveHold to update.

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

  • release_scheduleobject

    Configure when the ReserveHold will be released.

    • release_schedule.release_aftertimestampRequired

      The time after which the ReserveHold will be released.

Returns

Returns the updated ReserveHold object.

POST /v1/reserve/holds/:id
curl https://api.stripe.com/v1/reserve/holds/reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
  -d "release_schedule[release_after]"=1758588150 \
  -d "metadata[test_key]"=test_value
Response
{
  "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW",
  "object": "reserve.hold",
  "amount": 1000,
  "amount_releasable": 1000,
  "created": 1753380387,
  "created_by": "application",
  "currency": "usd",
  "is_releasable": true,
  "livemode": false,
  "metadata": {
    "test_key": "test_value"
  },
  "reason": "standalone",
  "release_schedule": {
    "release_after": 1758588150,
    "scheduled_release": 1758672000
  },
  "reserve_plan": null,
  "source_charge": null,
  "source_type": "card"
}