Skip to main content

subscriptionPlanGroupPagination

Searches subscription plan groups for paging to the next and previous results from a cursor.

subscriptionPlanGroupPagination(
  productIds: [SharedGlobalID!]
  productVariantIds: [SharedGlobalID!]
  query: String
  sortDirection: SortDirection
  sortKey: SubscriptionPlanGroupSortKey
  status: [SubscriptionPlanGroupStatus!]
): PaginationResult

Arguments​

subscriptionPlanGroupPagination.productIds ● [SharedGlobalID!] list scalar types​

Return only subscription plan groups that include these products.

subscriptionPlanGroupPagination.productVariantIds ● [SharedGlobalID!] list scalar types​

Return only subscription plan groups that include these product variants.

subscriptionPlanGroupPagination.query ● String scalar types​

A search query to filter subscription plan groups by ID, identifier, name or reference. Every word in the query must match.

subscriptionPlanGroupPagination.sortDirection ● SortDirection enum types​

The direction to sort subscription plan groups in. Defaults to ascending.

subscriptionPlanGroupPagination.sortKey ● SubscriptionPlanGroupSortKey enum types​

The field to sort subscription plan groups by. Defaults to ID.

subscriptionPlanGroupPagination.status ● [SubscriptionPlanGroupStatus!] list enum types​

Return only subscription plan groups with these statuses.

Type​

PaginationResult object types​

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