List Subscriptions

List all subscriptions with filtering and pagination

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.

Authorization: Bearer YOUR_API_KEY

Query Parameters

limit · integer

Number of items to return (default: 20, max: 100)

starting_after · string

Cursor for pagination (subscription ID)

status · string

Filter by status: “trialing”, “active”, “past_due”, “cancelled”, “unpaid”

customer_id · string

Filter by customer ID

plan_id · string

Filter by plan ID

created_from · string

Filter by creation date start (ISO 8601)

created_to · string

Filter by creation date end (ISO 8601)

ending_before_date · string

Show subscriptions ending before date

sort_by · string

Sort field: “created_at”, “start_date”, “total_amount”

sort_order · string

Sort order: “asc” or “desc”

Response

object · string

Object type, always “list”

data · array

Array of subscription objects

has_more · boolean

Whether more items exist

cURL

curl --location 'https://api.stateset.com/v1/subscriptions?status=active&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "object": "list",
  "data": [
    {
      "id": "sub_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "subscription",
      "customer_id": "cust_abc123",
      "customer_name": "Acme Corporation",
      "status": "active",
      "plan": {
        "id": "plan_monthly_pro",
        "name": "Professional Monthly",
        "amount": 9900
      },
      "total_amount": 11772,
      "current_period_end": "2024-03-01",
      "next_invoice_date": "2024-03-01"
    },
    {
      "id": "sub_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "subscription",
      "customer_id": "cust_def456",
      "customer_name": "TechCorp Inc",
      "status": "active",
      "plan": {
        "id": "plan_annual_enterprise",
        "name": "Enterprise Annual",
        "amount": 99900
      },
      "total_amount": 99900,
      "current_period_end": "2025-01-15",
      "next_invoice_date": "2025-01-15"
    }
  ],
  "has_more": true,
  "url": "/v1/subscriptions"
}