Skip to main content

searchSubscriptionPlanGroups

Searches subscription plan groups. The matches are in the subscriptionPlanGroups field of the result.

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

Arguments​

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

Return only subscription plan groups that include these products.

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

Return only subscription plan groups that include these product variants.

searchSubscriptionPlanGroups.query ● String scalar types​

Text to match against a plan group's ID, number, name or reference. Plan groups that include matching products are also returned.

searchSubscriptionPlanGroups.sortDirection ● SortDirection enum types​

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

searchSubscriptionPlanGroups.sortKey ● SubscriptionPlanGroupSortKey enum types​

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

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

Return only subscription plan groups with these statuses.

Type​

SearchResult object types​

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