Skip to main content
GET
List subscriptions

Query Parameters

Example Request

Response

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

status
enum<string>

Filter by subscription status.

Available options:
trialing,
active,
past_due,
paused,
canceled,
unpaid
plan_id
string<uuid>

Filter to one plan's subscriptions.

customer_id
string<uuid>

Filter to one customer's subscriptions.

started_after
string<date-time>

Keep subscriptions whose current period started at or after this RFC 3339 instant.

q
string

Free-text search filter.

limit
integer
default:50

Maximum records to return. Defaults to 50 when omitted and is capped at 1000 (a larger request returns the cap, not an error). Pass an explicit limit when you need the full set — omitting it silently returns only the first page.

Required range: 1 <= x <= 1000
page
integer
default:1

1-based page number.

Required range: x >= 1

Response

Subscriptions for the tenant.

data
object[]