Skip to main content
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
SubscriptionQueryFilter
Filter criteria for subscriptions
paging
CursorPaging
Pagination options
sorting
[SubscriptionQuerySort]
Sorting options

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.
Monitor trials approaching end date for conversion campaigns.
Query canceled subscriptions for churn reporting.