Sample - Stripe API
GET/v1/subscription_schedules

List subscription schedules

Lists subscription schedules that match the supplied lifecycle, customer, account, and creation-time filters. Use starting_after and ending_before to navigate the cursor-paginated results, and use limit to control the page size. By default, the results include schedules regardless of lifecycle state unless filters narrow the selection.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

11 parameters
canceled_atobjectoptional
Filter schedules canceled during the specified Unix timestamp or timestamp range.
completed_atobjectoptional
Filter schedules completed during the specified Unix timestamp or timestamp range.
createdobjectoptional
Filter schedules created during the specified Unix timestamp or timestamp range.
customerstringoptional
Filter schedules belonging to the specified customer. Schedules for customers with an attached test clock are excluded when omitted.
customer_accountstringoptional
Filter schedules belonging to the specified account. Must be no longer than 5000 characters.
ending_beforestringoptional
Cursor object identifier used to retrieve the page before the specified item. Must be no longer than 5000 characters.
expandarray<string>optional
Fields to expand in each returned schedule. Each field name must be no longer than 5000 characters.
limitintegeroptional
Maximum number of schedules to return. Must be between 1 and 100. Defaults to 10 when omitted.
released_atobjectoptional
Filter schedules released during the specified Unix timestamp or timestamp range.
scheduledbooleanoptional
Filter for schedules that have not started yet.
starting_afterstringoptional
Cursor object identifier used to retrieve the page after the specified item. Must be no longer than 5000 characters.

2 status codes
200Returns a paginated list object containing subscription schedules, the list URL, the object type, and a `has_more` indicator.
dataarray<SubscriptionSchedule>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

limit must be between 1 and 100 and defaults to 10 when omitted. Date filters such as created, canceled_at, completed_at, and released_at accept a Unix timestamp or range criteria. Use starting_after and ending_before with object identifiers to retrieve adjacent result pages.