Choose a version:

sellingPlanGroup

query

Returns a Selling Plan Group resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the SellingPlanGroup to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

SellingPlanGroup

•

SellingPlanGroup

Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

appId• String: The ID for app, exposed in Liquid and product JSON.
appliesToProduct• Boolean! non-null: Whether the given product is directly associated to the selling plan group.
appliesToProductVariant• Boolean! non-null: Whether the given product variant is directly associated to the selling plan group.
appliesToProductVariants• Boolean! non-null: Whether any of the product variants of the given product are associated to the selling plan group.
createdAt• DateTime! non-null: The date and time when the selling plan group was created.
description• String: The merchant-facing description of the selling plan group.
id• ID! non-null: A globally-unique ID.
merchantCode• String! non-null: The merchant-facing label of the selling plan group.
name• String! non-null: The buyer-facing label of the selling plan group.
options• [String!]! non-null: The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
position• Int: The relative position of the selling plan group for display.
products • ProductConnection! non-null: Products associated to the selling plan group.
productsCount• Count: A count of products associated to the selling plan group.
productVariants • ProductVariantConnection! non-null: Product variants associated to the selling plan group.
productVariantsCount• Count: A count of product variants associated to the selling plan group.
sellingPlans • SellingPlanConnection! non-null: Selling plans associated to the selling plan group.
summary• String: A summary of the policies associated to the selling plan group.
translations• [Translation!]! non-null: The published translations associated with the resource.

Was this section helpful?

Retrieve information about a selling plan group

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query sellingPlanGroups {

sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {

id,

name,

merchantCode,

appId,

description,

options,

position,

createdAt,

sellingPlans(first: 1) {

edges {

node {

}

productVariants(first: 1) {

edges {

node {

}

productVariantCount,

summary,

products(first: 1) {

edges {

node {

}

productCount,

appliesToProduct(productId: "gid://shopify/Product/1"),

appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")

app {

}

}`,

);

const data = await response.json();

query sellingPlanGroups {
  sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
    id,
    name,
    merchantCode,
    appId,
    description,
    options,
    position,
    createdAt,
    sellingPlans(first: 1) {
      edges {
        node {
          id
        }
      }
    }
    productVariants(first: 1) {
      edges {
        node {
          id
        }
      }
    }
    productVariantCount,
    summary,
    products(first: 1) {
      edges {
        node {
          id
        }
      }
    }
    productCount,
    appliesToProduct(productId: "gid://shopify/Product/1"),
    appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
    app {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query sellingPlanGroups { sellingPlanGroup(id: \"gid://shopify/SellingPlanGroup/1\") { id, name, merchantCode, appId, description, options, position, createdAt, sellingPlans(first: 1) { edges { node { id } } } productVariants(first: 1) { edges { node { id } } } productVariantCount, summary, products(first: 1) { edges { node { id } } } productCount, appliesToProduct(productId: \"gid://shopify/Product/1\"), appliesToProductVariant(productVariantId: \"gid://shopify/ProductVariant/1\") app { id } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query sellingPlanGroups {
    sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
      id,
      name,
      merchantCode,
      appId,
      description,
      options,
      position,
      createdAt,
      sellingPlans(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariants(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariantCount,
      summary,
      products(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productCount,
      appliesToProduct(productId: "gid://shopify/Product/1"),
      appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
      app {
        id
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query sellingPlanGroups {
    sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
      id,
      name,
      merchantCode,
      appId,
      description,
      options,
      position,
      createdAt,
      sellingPlans(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariants(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariantCount,
      summary,
      products(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productCount,
      appliesToProduct(productId: "gid://shopify/Product/1"),
      appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
      app {
        id
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query sellingPlanGroups {
    sellingPlanGroup(id: "gid://shopify/SellingPlanGroup/1") {
      id,
      name,
      merchantCode,
      appId,
      description,
      options,
      position,
      createdAt,
      sellingPlans(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariants(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productVariantCount,
      summary,
      products(first: 1) {
        edges {
          node {
            id
          }
        }
      }
      productCount,
      appliesToProduct(productId: "gid://shopify/Product/1"),
      appliesToProductVariant(productVariantId: "gid://shopify/ProductVariant/1")
      app {
        id
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"sellingPlanGroup": {

"id": "gid://shopify/SellingPlanGroup/1",

"name": "Subscribe & Save",

"merchantCode": "sub-n-save",

"appId": "gid://shopify/App/1",

"description": null,

"options": [

"Delivery every"

"position": null,

"createdAt": "2023-07-16T19:21:25Z",

"sellingPlans": {

"edges": [

{

"node": {

"id": "gid://shopify/SellingPlan/1"

}

]

"productVariants": {

"edges": [

{

"node": {

"id": "gid://shopify/ProductVariant/1"

}

]

"productVariantCount": 1,

"summary": "1 delivery frequency, 25-26% discount",

"products": {

"edges": [

{

"node": {

"id": "gid://shopify/Product/1"

}

]

"productCount": 1,

"appliesToProduct": true,

"appliesToProductVariant": true,

"app": {

"id": "gid://shopify/App/1"

}