Skip to main content
Anchor to sellingPlanGroups

sellingPlanGroups

query

Retrieves a paginated list of SellingPlanGroup objects that belong to the app making the API call. Selling plan groups are selling methods like subscriptions, preorders, or other purchase options that merchants offer to customers.

Each group has one or more SellingPlan objects that define specific billing and delivery schedules, pricing adjustments, and policies. Use the query argument to search by name or filter results by other criteria.

Learn more about building selling plans.

Anchor to Arguments

SellingPlanGroupConnection arguments

•SellingPlanGroupConnection!
Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to app_id
•id

Valid values:

  • CURRENT Default
  • ALL
  • * (numeric app ID)
Anchor to category
•string

A comma-separated list of categories.

Valid values:

  • SUBSCRIPTION
  • PRE_ORDER
  • TRY_BEFORE_YOU_BUY
  • OTHER
Anchor to created_at
•time
Anchor to delivery_frequency
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to name
•string
Anchor to percentage_off
•float
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•SellingPlanGroupSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[SellingPlanGroupEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[SellingPlanGroup!]!
non-null

A list of nodes that are contained in SellingPlanGroupEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?