List subscriptions

GET {{baseUrl}}/v1/subscriptions

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

Request Params

Key	Datatype	Description
`collection_method`	string	The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
`created[gt]`	string
`created[gte]`	string
`created[lt]`	string
`created[lte]`	string
`current_period_end[gt]`	string
`current_period_end[gte]`	string
`current_period_end[lt]`	string
`current_period_end[lte]`	string
`current_period_start[gt]`	string
`current_period_start[gte]`	string
`current_period_start[lt]`	string
`current_period_start[lte]`	string
`customer`	string	The ID of the customer whose subscriptions will be retrieved.
`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.
`price`	string	Filter for subscriptions that contain this recurring price ID.
`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.
`status`	string	The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
`test_clock`	string	Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string