Skip to main content

subscriptionPagination

Searches subscriptions for paging to the next and previous results from a cursor.

subscriptionPagination(
  customerIds: [SharedGlobalID!]
  filter: SubscriptionFilter
  healthStatus: [SubscriptionHealthStatus!]
  pendingCancellation: Boolean
  query: String
  sortDirection: SortDirection
  sortKey: SubscriptionSortKey
  status: [SubscriptionStatus!]
  subscriptionPlanGroupId: GlobalID
  subscriptionPlanId: GlobalID
): PaginationResult

Arguments​

subscriptionPagination.customerIds ● [SharedGlobalID!] deprecated list scalar types​

DEPRECATED

Use filter.customerIds instead.

Return only subscriptions belonging to these customers.

subscriptionPagination.filter ● SubscriptionFilter input types​

Structured filters for the subscriptions search. They take precedence over the matching top-level arguments.

subscriptionPagination.healthStatus ● [SubscriptionHealthStatus!] deprecated list enum types​

DEPRECATED

Use filter.healthStatus instead.

Return only subscriptions with these health statuses.

subscriptionPagination.pendingCancellation ● Boolean deprecated scalar types​

DEPRECATED

Use filter.pendingCancellation instead.

When true, return only subscriptions with a scheduled cancellation.

subscriptionPagination.query ● String scalar types​

A search query to filter subscriptions by identifier, customer or delivery details, or order name. Results are ranked by relevance and sortKey is ignored.

subscriptionPagination.sortDirection ● SortDirection enum types​

The direction to sort subscriptions in. Sorting applies only when sortKey is also set.

subscriptionPagination.sortKey ● SubscriptionSortKey enum types​

The field to sort subscriptions by. Sorting applies only when sortDirection is also set.

subscriptionPagination.status ● [SubscriptionStatus!] deprecated list enum types​

DEPRECATED

Use filter.status instead.

Return only subscriptions with these statuses.

subscriptionPagination.subscriptionPlanGroupId ● GlobalID deprecated scalar types​

DEPRECATED

Use filter.subscriptionPlanGroupId instead.

Return only subscriptions belonging to this subscription plan group.

subscriptionPagination.subscriptionPlanId ● GlobalID deprecated scalar types​

DEPRECATED

Use filter.subscriptionPlanId instead.

Return only subscriptions belonging to this subscription plan.

Type​

PaginationResult object types​

The results of a paginated search, identified by its query arguments.