Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
default:subm_your_key_here
required

Developer API key generated in the app. Keys carry scopes; a read key can call list, get, analytics, and audit endpoints, while a write key additionally allows create, update, cancel, pause, resume, and delete.

Query Parameters

limit
integer
default:50

Maximum number of subscriptions to return (1-100, default 50).

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

Number of subscriptions to skip from the start of the list (default 0).

Required range: x >= 0
status
enum<string>

Filter by lifecycle state. Lifecycle state. active means billing; paused means temporarily stopped; cancelled means no longer billing but kept for history.

Available options:
active,
paused,
cancelled
category
string

Exact category match, for example "Streaming".

period
enum<string>

Filter by billing period. Billing cadence. Monthly means the same calendar day each month; fixed-day intervals use custom.

Available options:
monthly,
yearly,
custom
q
string

Case-insensitive search over the subscription name.

expiringBefore
string

Return subscriptions whose nextPaymentDate is on or before this date. Combine with status=active to find renewals due soon. Calendar date without time, always in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-01"

sort
enum<string>
default:-createdAt

Sort order; prefix with - for descending, for example -nextPaymentDate.

Available options:
createdAt,
-createdAt,
nextPaymentDate,
-nextPaymentDate,
amount,
-amount,
name,
-name

Response

Subscriptions returned.

data
object[]
required
pagination
object
required
requestId
string
required
query
object

Echo of the sort and filters applied to this response.