subscriptions_list - Charter Docs

GET

stripe_subscriptions_list.py

import asyncio

from charter.packs import stripe

result = asyncio.run(stripe.subscriptions_list.ainvoke({}))

With stripe.RESTRICTED_KEY, requires subscription_read or subscription_write. Pages by cursor: data[-1].id is sent back as starting_after.

Query parameters

Field	Type	Description
`limit`	`integer`	A limit on the number of objects to be returned, between 1 and 100. Defaults to 10. ≥ 1; ≤ 100; defaults to `10`
`startingAfter`	`string`	A cursor for use in pagination: an object ID that defines your place in the list. To get the next page, pass the id of the last object in the current page.
`endingBefore`	`string`	A cursor for use in pagination: an object ID that defines your place in the list. Returns the page before the named object. Mutually exclusive with starting_after.
`customer`	`string`	The ID of the customer whose subscriptions will be retrieved.
`price`	`string`	Filter for subscriptions that contain this recurring price ID.
`status`	SubscriptionStatus	The status of the subscriptions to retrieve. Pass ‘all’ to return subscriptions of all statuses.