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

Create a ReserveRelease Preview

Create a ReserveRelease.

Parameters

  • reserve_holdstringRequired

    The ReserveHold to release.

  • amountinteger

    Amount to be released from the provided ReserveHold. A positive integer representing how much to release in the smallest currency unit (e.g., 100 cents to release $1.00 or 100 to release ¥100, a zero-decimal currency). If not provided, the full releasable amount of the ReserveHold will be released.

  • currencyenum

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

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

Returns

Returns a ReserveRelease object.

POST /v1/reserve/releases
cURL
curl https://api.stripe.com/v1/reserve/releases \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
  -d reserve_hold=reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW \
  -d amount=500 \
  -d currency=usd
Response
{
  "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
}

Update a ReserveRelease Preview

Update a ReserveRelease’s metadata.

Parameters

  • idstringRequired

    The identifier of the ReserveRelease to update.

  • metadataobjectRequired

    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.

Returns

Returns the updated ReserveRelease object.

POST /v1/reserve/releases/:id
cURL
curl https://api.stripe.com/v1/reserve/releases/resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}" \
  -d "metadata[test_key]"=test_value
Response
{
  "id": "resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW",
  "object": "reserve.release",
  "amount": 500,
  "created": 1753406491,
  "created_by": "application",
  "currency": "usd",
  "livemode": false,
  "metadata": {
    "test_key": "test_value"
  },
  "reason": "hold_released_early",
  "released_at": 1753406491,
  "reserve_hold": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW",
  "reserve_plan": null
}

Retrieve a ReserveRelease Preview

Retrieve a ReserveRelease.

Parameters

  • idstringRequired

    The identifier of the ReserveRelease to retrieve.

Returns

Returns a ReserveRelease object.

GET /v1/reserve/releases/:id
cURL
curl https://api.stripe.com/v1/reserve/releases/resrel_61SxyHbQOe90T6sLB41Q8rCFhzAUW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "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
}

List ReserveReleases Preview

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

Parameters

  • currencyenum

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

  • reserve_holdstring

    Only return ReserveReleases associated with the ReserveHold specified by this ReserveHold ID.

  • reserve_planstring

    Only return ReserveReleases associated with the ReservePlan specified by this ReservePlan ID.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

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

GET /v1/reserve/releases
cURL
curl -G https://api.stripe.com/v1/reserve/releases \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d reserve_plan=resplan_61SToUQzaDa1N5nJh412e824LPfdz \
  -d limit=10
Response
{
  "object": "list",
  "data": [
    {
      "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
    },
    {
      "id": "resrel_61SxxvDiTp12IiQA441Q8rCFhzAUW",
      "object": "reserve.release",
      "amount": 2904,
      "created": 1753405103,
      "created_by": "stripe",
      "currency": "usd",
      "livemode": false,
      "reason": "plan_disabled",
      "released_at": 1753405102,
      "reserve_hold": null,
      "reserve_plan": "resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW"
    }
  ],
  "has_more": false,
  "url": "/v1/reserve/releases"
}

Early Fraud Warning 

An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.

Related guide: Early fraud warnings

Endpoints