Skip to main content

subscriptionOrderPagination

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

subscriptionOrderPagination(
  customerIds: [SharedGlobalID!]
  filter: SubscriptionOrderFilter
  paymentStatus: [SubscriptionOrderPaymentStatus!]
  query: String
  sortDirection: SortDirection
  sortKey: SubscriptionOrderSortKey
  status: [SubscriptionOrderStatus!]
  subscriptionId: GlobalID
  subscriptionPlanId: GlobalID
): PaginationResult

Arguments​

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

DEPRECATED

Use filter.customerIds instead.

Return only subscription orders belonging to these customers.

subscriptionOrderPagination.filter ● SubscriptionOrderFilter input types​

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

subscriptionOrderPagination.paymentStatus ● [SubscriptionOrderPaymentStatus!] deprecated list enum types​

DEPRECATED

Use filter.paymentStatus instead.

Return only subscription orders with these payment statuses.

subscriptionOrderPagination.query ● String scalar types​

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

subscriptionOrderPagination.sortDirection ● SortDirection enum types​

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

subscriptionOrderPagination.sortKey ● SubscriptionOrderSortKey enum types​

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

subscriptionOrderPagination.status ● [SubscriptionOrderStatus!] deprecated list enum types​

DEPRECATED

Use filter.status instead.

Return only subscription orders with these statuses.

subscriptionOrderPagination.subscriptionId ● GlobalID deprecated scalar types​

DEPRECATED

Use filter.subscriptionId instead.

Return only subscription orders belonging to this subscription.

subscriptionOrderPagination.subscriptionPlanId ● GlobalID deprecated scalar types​

DEPRECATED

Use filter.subscriptionPlanId instead.

Return only subscription orders belonging to this subscription plan.

Type​

PaginationResult object types​

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