Get list of subscriptions

📘
API Refs

Staging: Get list of subscriptions

Request parameters

Name	Type	Description	Required
limit	number	Maximum number of subscriptions to return (default: 20, max: 100)	no
starting_after	string	Cursor for pagination. Use the last StripeSubscriptionID from previous page	no
status	string	Filter by subscription status (active, canceled, past_due, incomplete, incomplete_expired, trialing, unpaid, paused)	no
customer_id	string	Filter by StripeCustomerID	no

Response body

Returns a paginated response with:

data: Array of subscription objects, each containing:
- id: StripeSubscriptionID
- status: Subscription status
- customer: Customer details (id, email, name)
- plan: Plan details (id, stripeId, name, amount, currency, interval)
- currentPeriodStart: Current billing period start
- currentPeriodEnd: Current billing period end
- cancelAtPeriodEnd: Whether subscription cancels at period end
- createdAt: Creation timestamp
pagination: Pagination details
- limit: Number of items returned
- hasMore: Whether more items exist
- nextCursor: Cursor for next page

Description

This endpoint retrieves a paginated list of all subscriptions for your merchant account. You can filter the results by status or customer, and use cursor-based pagination to navigate through large result sets.