Choose a version:

sellingPlanGroupUpdate

mutation

Requires write_products access scope as well as any of write_own_subscription_contracts, write_purchase_options access scopes. Also: The user must have manage_orders_information permissions.

Update a Selling Plan Group.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The Selling Plan Group to update.

Anchor to inputinput

•SellingPlanGroupInput!

required

The properties of the Selling Plan Group to update.

Show input fields

Was this section helpful?

Anchor to SellingPlanGroupUpdatePayload returnsSellingPlanGroupUpdatePayload returns

Anchor to deletedSellingPlanIdsdeletedSellingPlanIds •[ID!]: The IDs of the deleted Subscription Plans.
Anchor to sellingPlanGroupsellingPlanGroup •SellingPlanGroup: The updated Selling Plan Group.

Show fields
Anchor to userErrorsuserErrors •[SellingPlanGroupUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Update a selling plan group and its metafields

Query

mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
  sellingPlanGroupUpdate(id: $id, input: $input) {
    sellingPlanGroup {
      id
      sellingPlans(first: 1) {
        edges {
          node {
            id
            metafields(first: 1) {
              edges {
                node {
                  id
                  namespace
                  key
                  value
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/SellingPlanGroup/964742479",
  "input": {
    "sellingPlansToUpdate": [
      {
        "id": "gid://shopify/SellingPlan/563068713",
        "metafields": [
          {
            "value": "waterproof",
            "type": "single_line_text_field",
            "key": "test_key",
            "namespace": "example-selling-plan"
          }
        ]
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) { sellingPlanGroupUpdate(id: $id, input: $input) { sellingPlanGroup { id sellingPlans(first: 1) { edges { node { id metafields(first: 1) { edges { node { id namespace key value } } } } } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/SellingPlanGroup/964742479",
    "input": {
      "sellingPlansToUpdate": [
        {
          "id": "gid://shopify/SellingPlan/563068713",
          "metafields": [
            {
              "value": "waterproof",
              "type": "single_line_text_field",
              "key": "test_key",
              "namespace": "example-selling-plan"
            }
          ]
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
    sellingPlanGroupUpdate(id: $id, input: $input) {
      sellingPlanGroup {
        id
        sellingPlans(first: 1) {
          edges {
            node {
              id
              metafields(first: 1) {
                edges {
                  node {
                    id
                    namespace
                    key
                    value
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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
  mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
    sellingPlanGroupUpdate(id: $id, input: $input) {
      sellingPlanGroup {
        id
        sellingPlans(first: 1) {
          edges {
            node {
              id
              metafields(first: 1) {
                edges {
                  node {
                    id
                    namespace
                    key
                    value
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/SellingPlanGroup/964742479",
  "input": {
    "sellingPlansToUpdate": [
      {
        "id": "gid://shopify/SellingPlan/563068713",
        "metafields": [
          {
            "value": "waterproof",
            "type": "single_line_text_field",
            "key": "test_key",
            "namespace": "example-selling-plan"
          }
        ]
      }
    ]
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
      sellingPlanGroupUpdate(id: $id, input: $input) {
        sellingPlanGroup {
          id
          sellingPlans(first: 1) {
            edges {
              node {
                id
                metafields(first: 1) {
                  edges {
                    node {
                      id
                      namespace
                      key
                      value
                    }
                  }
                }
              }
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
  sellingPlanGroupUpdate(id: $id, input: $input) {
    sellingPlanGroup {
      id
      sellingPlans(first: 1) {
        edges {
          node {
            id
            metafields(first: 1) {
              edges {
                node {
                  id
                  namespace
                  key
                  value
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/SellingPlanGroup/964742479",
  "input": {
    "sellingPlansToUpdate": [
      {
        "id": "gid://shopify/SellingPlan/563068713",
        "metafields": [
          {
            "value": "waterproof",
            "type": "single_line_text_field",
            "key": "test_key",
            "namespace": "example-selling-plan"
          }
        ]
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
        sellingPlanGroupUpdate(id: $id, input: $input) {
          sellingPlanGroup {
            id
            sellingPlans(first: 1) {
              edges {
                node {
                  id
                  metafields(first: 1) {
                    edges {
                      node {
                        id
                        namespace
                        key
                        value
                      }
                    }
                  }
                }
              }
            }
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "sellingPlanGroupUpdate": {
    "sellingPlanGroup": {
      "id": "gid://shopify/SellingPlanGroup/964742479",
      "sellingPlans": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/SellingPlan/563068713",
              "metafields": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/Metafield/616145134",
                      "namespace": "example-selling-plan",
                      "key": "test_key",
                      "value": "waterproof"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "userErrors": []
  }
}

sellingPlanGroupUpdate reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {

sellingPlanGroupUpdate(id: $id, input: $input) {

sellingPlanGroup {

sellingPlans(first: 1) {

edges {

node {

metafields(first: 1) {

edges {

node {

namespace

key

value

}

userErrors {

field

message

}

}`,

{

variables: {

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

"input": {

"sellingPlansToUpdate": [

{

"id": "gid://shopify/SellingPlan/563068713",

"metafields": [

{

"value": "waterproof",

"type": "single_line_text_field",

"key": "test_key",

"namespace": "example-selling-plan"

}

]

}

]

}

);

const json = await response.json();

return json.data;

}

GQL

mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
  sellingPlanGroupUpdate(id: $id, input: $input) {
    sellingPlanGroup {
      id
      sellingPlans(first: 1) {
        edges {
          node {
            id
            metafields(first: 1) {
              edges {
                node {
                  id
                  namespace
                  key
                  value
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) { sellingPlanGroupUpdate(id: $id, input: $input) { sellingPlanGroup { id sellingPlans(first: 1) { edges { node { id metafields(first: 1) { edges { node { id namespace key value } } } } } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/SellingPlanGroup/964742479",
    "input": {
      "sellingPlansToUpdate": [
        {
          "id": "gid://shopify/SellingPlan/563068713",
          "metafields": [
            {
              "value": "waterproof",
              "type": "single_line_text_field",
              "key": "test_key",
              "namespace": "example-selling-plan"
            }
          ]
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
    sellingPlanGroupUpdate(id: $id, input: $input) {
      sellingPlanGroup {
        id
        sellingPlans(first: 1) {
          edges {
            node {
              id
              metafields(first: 1) {
                edges {
                  node {
                    id
                    namespace
                    key
                    value
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
      sellingPlanGroupUpdate(id: $id, input: $input) {
        sellingPlanGroup {
          id
          sellingPlans(first: 1) {
            edges {
              node {
                id
                metafields(first: 1) {
                  edges {
                    node {
                      id
                      namespace
                      key
                      value
                    }
                  }
                }
              }
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  },
});

Ruby

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
  mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
    sellingPlanGroupUpdate(id: $id, input: $input) {
      sellingPlanGroup {
        id
        sellingPlans(first: 1) {
          edges {
            node {
              id
              metafields(first: 1) {
                edges {
                  node {
                    id
                    namespace
                    key
                    value
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/SellingPlanGroup/964742479",
  "input": {
    "sellingPlansToUpdate": [
      {
        "id": "gid://shopify/SellingPlan/563068713",
        "metafields": [
          {
            "value": "waterproof",
            "type": "single_line_text_field",
            "key": "test_key",
            "namespace": "example-selling-plan"
          }
        ]
      }
    ]
  }
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
  sellingPlanGroupUpdate(id: $id, input: $input) {
    sellingPlanGroup {
      id
      sellingPlans(first: 1) {
        edges {
          node {
            id
            metafields(first: 1) {
              edges {
                node {
                  id
                  namespace
                  key
                  value
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/SellingPlanGroup/964742479",
  "input": {
    "sellingPlansToUpdate": [
      {
        "id": "gid://shopify/SellingPlan/563068713",
        "metafields": [
          {
            "value": "waterproof",
            "type": "single_line_text_field",
            "key": "test_key",
            "namespace": "example-selling-plan"
          }
        ]
      }
    ]
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation sellingPlanGroupUpdate($id: ID!, $input: SellingPlanGroupInput!) {
        sellingPlanGroupUpdate(id: $id, input: $input) {
          sellingPlanGroup {
            id
            sellingPlans(first: 1) {
              edges {
                node {
                  id
                  metafields(first: 1) {
                    edges {
                      node {
                        id
                        namespace
                        key
                        value
                      }
                    }
                  }
                }
              }
            }
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/SellingPlanGroup/964742479",
        "input": {
            "sellingPlansToUpdate": [
                {
                    "id": "gid://shopify/SellingPlan/563068713",
                    "metafields": [
                        {
                            "value": "waterproof",
                            "type": "single_line_text_field",
                            "key": "test_key",
                            "namespace": "example-selling-plan"
                        }
                    ]
                }
            ]
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

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

"input": {

"sellingPlansToUpdate": [

{

"id": "gid://shopify/SellingPlan/563068713",

"metafields": [

{

"value": "waterproof",

"type": "single_line_text_field",

"key": "test_key",

"namespace": "example-selling-plan"

}

]

}

]

}

Response

JSON

{

"sellingPlanGroupUpdate": {

"sellingPlanGroup": {

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

"sellingPlans": {

"edges": [

{

"node": {

"id": "gid://shopify/SellingPlan/563068713",

"metafields": {

"edges": [

{

"node": {

"id": "gid://shopify/Metafield/616145134",

"namespace": "example-selling-plan",

"key": "test_key",

"value": "waterproof"

}

]

}

]

}

"userErrors": []

}