Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Query Parameters

customer
string

Filter by customer id.

status
enum<string>

Filter by status.

Available options:
incomplete,
trialing,
active,
past_due,
unpaid,
canceled
limit
integer
default:20

Page size (default 20, max 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip.

Required range: x >= 0
starting_after
string

Cursor: a subscription id (typically the previous response's next_cursor). Returns results strictly after it, newest first. Cannot be combined with offset.

Response

A paginated list of subscriptions.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required

True when more records exist beyond this page.

total_count
integer
required

Total number of subscriptions matching the query.

next_cursor
string

Present when has_more is true: the last returned subscription's id. Pass it as starting_after on the next request.