Skip to main content
GET
This endpoint retrieves a paginated list of subscriptions. Use filters to narrow results by status, customer, plan, and more.

Authentication

This endpoint requires a valid API key with subscriptions:read permissions.

Query Parameters

integer
Number of items to return (default: 20, max: 100)
string
Cursor for pagination (subscription ID)
string
Filter by status: “trialing”, “active”, “past_due”, “cancelled”, “unpaid”
string
Filter by customer ID
string
Filter by plan ID
string
Filter by creation date start (ISO 8601)
string
Filter by creation date end (ISO 8601)
string
Show subscriptions ending before date
string
Sort field: “created_at”, “start_date”, “total_amount”
string
Sort order: “asc” or “desc”

Response

string
Object type, always “list”
array
Array of subscription objects
boolean
Whether more items exist