v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

List all schedules

Retrieves the list of your subscription schedules.

get/v1/subscription_schedules

Query parameters

OR
integer

Only return subscription schedules that were created canceled the given date interval.

OR
integer

Only return subscription schedules that completed during the given date interval.

OR
integer

Only return subscription schedules that were created during the given date interval.

customerstring

Only return subscription schedules for the given customer. The response will not include subscription schedules for customers with a test clock attached if this parameter is not set.

customer_accountstring

Only return subscription schedules for the given account.

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.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

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

OR
integer

Only return subscription schedules that were released during the given date interval.

scheduledboolean

Only return subscription schedules that have not started yet.

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.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.