searchSubscriptions
Searches subscriptions. The matches are in the subscriptions field of the result.
searchSubscriptions(
customerIds: [SharedGlobalID!]
filter: SubscriptionFilter
healthStatus: [SubscriptionHealthStatus!]
pendingCancellation: Boolean
query: String
sortDirection: SortDirection
sortKey: SubscriptionSortKey
status: [SubscriptionStatus!]
subscriptionPlanGroupId: GlobalID
subscriptionPlanId: GlobalID
): SearchResult
Arguments
searchSubscriptions.customerIds ● [SharedGlobalID!] deprecated list scalar types
Use filter.customerIds instead.
Return only subscriptions belonging to these customers.
searchSubscriptions.filter ● SubscriptionFilter input types
Filters that narrow the subscriptions search. They take precedence over the matching top-level arguments.
searchSubscriptions.healthStatus ● [SubscriptionHealthStatus!] deprecated list enum types
Use filter.healthStatus instead.
Return only subscriptions with these health statuses.
searchSubscriptions.pendingCancellation ● Boolean deprecated scalar types
Use filter.pendingCancellation instead.
Return only subscriptions with a scheduled cancellation when true.
searchSubscriptions.query ● String scalar types
Text to search for across identifiers, customer details, delivery names and phones, and order names and IDs. Results are ranked by relevance.
searchSubscriptions.sortDirection ● SortDirection enum types
The direction to sort subscriptions in.
searchSubscriptions.sortKey ● SubscriptionSortKey enum types
The field to sort subscriptions by. It needs sortDirection, and is ignored when query is set.
searchSubscriptions.status ● [SubscriptionStatus!] deprecated list enum types
Use filter.status instead.
Return only subscriptions with these statuses.
searchSubscriptions.subscriptionPlanGroupId ● GlobalID deprecated scalar types
Use filter.subscriptionPlanGroupId instead.
Return only subscriptions on plans in this subscription plan group.
searchSubscriptions.subscriptionPlanId ● GlobalID deprecated scalar types
Use filter.subscriptionPlanId instead.
Return only subscriptions belonging to this subscription plan.
Type
SearchResult object types
The results of a search, identified by its query arguments.