Disable a ReservePlan Preview

Reserves

Reserve Plans

Disable a ReservePlan

Disables a ReservePlan by transitioning it to a disabling state.

All associated ReserveHolds will be asynchronously released, after which the plan will automatically transition to disabled state.

Note: This action is irreversible - a disabled ReservePlan cannot be re-enabled.

Parameters

idstringRequired
The identifier of the ReservePlan to disable.

Returns

Returns the updated ReservePlan object.

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

Server-side language

curl -X POST https://api.stripe.com/v1/reserve/plans/resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW/disable \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

Response

{
  "id": "resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW",
  "object": "reserve.plan",
  "created": 1753380438,
  "created_by": "application",
  "currency": "usd",
  "disabled_at": null,
  "livemode": false,
  "metadata": {},
  "percent": 15,
  "rolling_release": {
    "days_after_charge": 30,
    "expires_on": 1755972438
  },
  "status": "disabling",
  "type": "rolling_release"
}

Disable a ReservePlan Preview

Parameters

idstringRequired

Returns