Skip to main content
GET
List Subscriptions

Authorizations

x-fngs-public-key
string
header
required

Query Parameters

status
enum<string>

Filter Subscriptions by their status: - active: Currently active Subscription - past_due: Payment failed but will retry - canceled: Subscription has been canceled - incomplete: Initial payment failed - incomplete_expired: Initial payment failed and expired - trialing: In trial period - unpaid: Payment failed and won't retry

Available options:
all,
active,
canceled,
incomplete,
incomplete_expired,
past_due,
trialing,
paused,
unpaid
userId
string<uuid>

Filter Subscriptions by User ID

createdFrom
integer<int64> | null

Filter Subscriptions created on or after this timestamp. Accepts Unix timestamp in seconds or milliseconds. Must not be later than createdTo.

Required range: 0 <= x <= 9007199254740991
createdTo
integer<int64> | null

Filter Subscriptions created on or before this timestamp. Accepts Unix timestamp in seconds or milliseconds. Must not be earlier than createdFrom.

Required range: 0 <= x <= 9007199254740991
cursor
string

Pagination cursor for fetching next page

take
integer<int64>
default:10

Number of Subscriptions per page (default: 10, max: 100)

Required range: 1 <= x <= 100

Response

GET /v0/subscriptions/list Positive response

status
string
required
Allowed value: "success"
data
object
required