List ReservePlans Preview

Reserves
Reserve Plans
List ReservePlans

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

Parameters

No parameters.

More parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

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

GET /v1/reserve/plans
curl https://api.stripe.com/v1/reserve/plans \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"
Response
{
"object": "list",
"data": [
{
"id": "resplan_61SxxwCbZ70gJfcoy41Q8rCFhzAUW",
"object": "reserve.plan",
"created": 1753405164,
"created_by": "application",
"currency": "usd",
"disabled_at": null,
"livemode": false,
"metadata": {},
"percent": 15,
"rolling_release": {
"days_after_charge": 30,
"expires_on": 1755997163
},
"status": "active",
"type": "rolling_release"
},
{
"id": "resplan_61SxrVOzQu6XIJSCx41Q8rCFhzAUW",
"object": "reserve.plan",
"created": 1753380438,
"created_by": "application",
"currency": "usd",
"disabled_at": 1753405108,
"livemode": false,
"metadata": {},
"percent": 15,
"rolling_release": {
"days_after_charge": 30,
"expires_on": 1755972438
},
"status": "disabled",
"type": "rolling_release"
}
],
"has_more": false,
"url": "/v1/reserve/plans"
}