Skip to main content
GET
List Subscriptions
Paginated subscriptions for your business and environment, newest first.

Request authentication

This endpoint requires a Secret Key (sk_...).

Query parameters

string
trialing, active, past_due, paused, canceled or expired.
string
Only subscriptions on this plan.
string
Only subscriptions belonging to this customer.
integer
default:"1"
The page to return.
integer
default:"15"
How many per page.

Authorizations

x-api-key
string
header
required

Query Parameters

status
enum<string>
Available options:
trialing,
active,
past_due,
paused,
canceled,
expired
plan
string
customer
string
page
integer
default:1
limit
integer
default:15

Response

A page of subscriptions, newest first.

A page of subscriptions, newest first.

message
string
data
object[]
meta
object

Where this page sits in the full result set.