Update a ReserveHold Preview

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.

Returns

Returns the updated ReserveHold object.

POST /v1/reserve/holds/:id

cURL

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

Retrieve a ReserveHold Preview

Retrieve a ReserveHold.

Parameters

idstringRequired
The identifier of the ReserveHold to retrieve.

Returns

Returns a ReserveHold object.

GET /v1/reserve/holds/:id

cURL

curl https://api.stripe.com/v1/reserve/holds/reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

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": {},
  "reason": "standalone",
  "release_schedule": {
    "release_after": 1755972386,
    "scheduled_release": 1755993600
  },
  "reserve_plan": null,
  "source_charge": null,
  "source_type": "card"
}

List ReserveHolds Preview

Returns a list of ReserveHolds previously created. The ReserveHolds are returned in sorted order, with the most recent ReserveHolds appearing first.

Parameters

currencyenum
Only return ReserveHolds associated with the currency specified by this currency code. Three-letter ISO currency code, in lowercase. Must be a supported currency.

is_releasableboolean
Only return ReserveHolds that are releasable.

reserve_planstring
Only return ReserveHolds associated with the ReservePlan specified by this ReservePlan ID.

reserve_releasestring
Only return ReserveHolds associated with the ReserveRelease specified by this ReserveRelease ID.

source_chargestring
Only return ReserveHolds associated with the Charge specified by this source charge ID.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit ReserveHolds, starting after ReserveHold starting_after and ending before ReserveHold ending_before. Each entry in the array is a separate ReserveHold object. If no more ReserveHolds are available, the resulting array will be empty.

GET /v1/reserve/holds

cURL

curl https://api.stripe.com/v1/reserve/holds \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

Response

{
  "object": "list",
  "data": [
    {
      "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"
    },
    {
      "id": "reshold_61SxrVXoFxfur37Dn41Q8rCFhzAUW",
      "object": "reserve.hold",
      "amount": 500,
      "amount_releasable": 500,
      "created": 1753380371,
      "created_by": "application",
      "currency": "usd",
      "is_releasable": true,
      "livemode": false,
      "metadata": {},
      "reason": "charge",
      "release_schedule": {
        "release_after": null,
        "scheduled_release": 1755993600
      },
      "reserve_plan": "resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW",
      "source_charge": "ch_1RoTYAQ8rCFhzAUW6hEROA88",
      "source_type": "card"
    }
  ],
  "has_more": false,
  "url": "/v1/reserve/holds"
}

Reserve Plans Preview

ReservePlans are used to automatically place holds on a merchant’s funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).

Endpoints

POST/v1/reserve/plans

POST/v1/reserve/plans/:id

GET/v1/reserve/plans/:id

GET/v1/reserve/plans

POST/v1/reserve/plans/:id/disable