Sign in
Subscriptions

Get a list of subscriptions

Retrieves a paginated list of subscriptions, with optional filters for customer, status, and plan.

get/api/v1/subscriptions

Query parameters

afterstring uuid

Return items that come after this cursor

beforestring uuid

Return items that come before this cursor

limitinteger

Maximum number of items to return

customerIdstring

Filter by customer ID

statusstring[]

Filter by subscription status. Supports comma-separated values for multiple statuses

planIdstring

Filter by plan ID

resourceIdstring

Filter by resource ID

pricingTypestring[]

Filter by pricing type. Supports comma-separated values for multiple types

gtstring date-time

Greater than the specified createdAt value

gtestring date-time

Greater than or equal to the specified createdAt value

ltstring date-time

Less than the specified createdAt value

ltestring date-time

Less than or equal to the specified createdAt value

Filter by creation date using range operators: gt, gte, lt, lte

Response

A paginated list of subscription objects.

Changes