List all schedules
GET {{baseUrl}}/v1/subscription_schedules
Retrieves the list of your subscription schedules.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
canceled_at[gt] | string | Only return subscription schedules that were created canceled the given date interval. | |
canceled_at[gte] | string | Only return subscription schedules that were created canceled the given date interval. | |
canceled_at[lt] | string | Only return subscription schedules that were created canceled the given date interval. | |
canceled_at[lte] | string | Only return subscription schedules that were created canceled the given date interval. | |
completed_at[gt] | string | Only return subscription schedules that completed during the given date interval. | |
completed_at[gte] | string | Only return subscription schedules that completed during the given date interval. | |
completed_at[lt] | string | Only return subscription schedules that completed during the given date interval. | |
completed_at[lte] | string | Only return subscription schedules that completed during the given date interval. | |
created[gt] | string | Only return subscription schedules that were created during the given date interval. | |
created[gte] | string | Only return subscription schedules that were created during the given date interval. | |
created[lt] | string | Only return subscription schedules that were created during the given date interval. | |
created[lte] | string | Only return subscription schedules that were created during the given date interval. | |
customer | string | Only return subscription schedules for the given customer. | |
ending_before | string | 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. | |
expand[0] | string | Specifies which fields in the response should be expanded. | |
expand[1] | string | Specifies which fields in the response should be expanded. | |
limit | string | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. | |
released_at[gt] | string | Only return subscription schedules that were released during the given date interval. | |
released_at[gte] | string | Only return subscription schedules that were released during the given date interval. | |
released_at[lt] | string | Only return subscription schedules that were released during the given date interval. | |
released_at[lte] | string | Only return subscription schedules that were released during the given date interval. | |
scheduled | string | Only return subscription schedules that have not started yet. | |
starting_after | string | 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. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |