Documentation Index
Fetch the complete documentation index at: https://docs.stigg.io/llms.txt
Use this file to discover all available pages before exploring further.
Retrieves a paginated list of subscriptions with optional filtering and sorting.
Query
query ListSubscriptions(
$filter: SubscriptionQueryFilter
$paging: CursorPaging
$sorting: [SubscriptionQuerySort!]
) {
subscriptions(filter: $filter, paging: $paging, sorting: $sorting) {
edges {
node {
subscriptionId
status
startDate
currentBillingPeriodEnd
plan {
refId
displayName
}
customer {
customerId
name
}
prices {
billingPeriod
price {
amount
currency
}
}
}
cursor
}
pageInfo {
hasNextPage
endCursor
}
totalCount
}
}
Parameters
Filter criteria for subscriptions
Filter by subscription ID
status
SubscriptionStatusFilterComparison
Filter by status (ACTIVE, IN_TRIAL, CANCELED, etc.)
Filter by customer internal ID
Filter by cancellation date
Filter by billing provider subscription ID
pricingType
PricingTypeFilterComparison
Filter by pricing type (FREE, PAID, CUSTOM)
Pagination options
Cursor to fetch items after
Sorting options
field
SubscriptionQuerySortFields
required
Field to sort by: createdAt, startDate, status
Sort direction: ASC or DESC
Filter Examples
Active subscriptions only
{
"filter": {
"status": { "eq": "ACTIVE" }
}
}
Trials ending soon
{
"filter": {
"status": { "eq": "IN_TRIAL" },
"trialEndDate": {
"lte": "2024-01-31T23:59:59Z"
}
}
}
Canceled in date range
{
"filter": {
"status": { "eq": "CANCELED" },
"cancellationDate": {
"gte": "2024-01-01T00:00:00Z",
"lte": "2024-01-31T23:59:59Z"
}
}
}
Common Use Cases
Display all subscriptions with filtering by status and customer.
Trial conversion tracking
Monitor trials approaching end date for conversion campaigns.
Query canceled subscriptions for churn reporting.
