GET /v1/subscriptions

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

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Query parameters

Name	Type	Required	Description
`price`	String	No	Filter for subscriptions that contain this recurring price ID.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`automatic_tax`	Object	No	Filter subscriptions by their automatic tax settings.
`ending_before`	String	No	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.
`status`	String	No	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. Possible values: `"ended"` `"active"` `"incomplete_expired"` `"trialing"` `"past_due"` `"unpaid"` `"incomplete"` `"paused"` `"canceled"` `"all"`
`current_period_start`		No	Only return subscriptions whose current_period_start falls within the given date interval.
`collection_method`	String	No	The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. Possible values: `"send_invoice"` `"charge_automatically"`
`customer`	String	No	The ID of the customer whose subscriptions will be retrieved.
`created`		No	Only return subscriptions that were created during the given date interval.
`limit`	Integer	No	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`starting_after`	String	No	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.
`test_clock`	String	No	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.
`current_period_end`		No	Only return subscriptions whose current_period_end falls within the given date interval.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.