provider GET /v1/subscriptions
@utdk/stripe /v1/subscriptions
List subscriptions
<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>
automatic_tax query
Filter subscriptions by their automatic tax settings.
object
collection_method query
The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
enum: charge_automatically, send_invoice
created query
Only return subscriptions that were created during the given date interval.
current_period_end query
Only return subscriptions whose minimum item current_period_end falls within the given date interval.
current_period_start query
Only return subscriptions whose maximum item current_period_start falls within the given date interval.
customer query
The ID of the customer whose subscriptions you're retrieving.
string
customer_account query
The ID of the account representing the customer whose subscriptions you're retrieving.
string
ending_before query
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.
string
expand query
Specifies which fields in the response should be expanded.
array
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
price query
Filter for subscriptions that contain this recurring price ID.
string
starting_after query
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.
string
status query
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](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). 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.
enum: active, all, canceled, ended…
test_clock query
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.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getsubscriptions
GET/v1/subscriptions
<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>

Filter subscriptions by their automatic tax settings.

The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.

Only return subscriptions that were created during the given date interval.

Only return subscriptions whose minimum item current_period_end falls within the given date interval.

Only return subscriptions whose maximum item current_period_start falls within the given date interval.

The ID of the customer whose subscriptions you're retrieving.

The ID of the account representing the customer whose subscriptions you're retrieving.

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.

Specifies which fields in the response should be expanded.

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

Filter for subscriptions that contain this recurring price ID.

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.

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](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). 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.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getsubscriptions()