SellingPlanGroup object

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.

Required access

Requires access to either all or app-owned selling plans.

On this page

• Connections
• Fields
• Types that return SellingPlanGroup
• Mutations for SellingPlanGroup
• Implements

Connections

• productVariants ([ProductVariantConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
  Product variants associated to the selling plan group.

• products ([ProductConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
  Products associated to the selling plan group.

• sellingPlans ([SellingPlanConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplan))
  Selling plans associated to the selling plan group.

• Fields

• appId ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The identifier for app, exposed in Liquid and product JSON.
• appliesToProduct ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the given product is directly associated to the selling plan group.

• appliesToProductVariant ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the given product variant is directly associated to the selling plan group.

• appliesToProductVariants ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether any of the product variants of the given product are associated to the selling plan group.

• createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date and time when the selling plan group was created.
• description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The merchant-facing description of the selling plan group.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• merchantCode ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The merchant-facing label of the selling plan group.
• name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The buyer-facing label of the selling plan group.
• options ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
• position ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The relative position of the selling plan group for display.
• productCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  A count of products associated to the selling plan group.
• productVariantCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  A count of product variants associated to the selling plan group.

• summary ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A summary of the policies associated to the selling plan group.

Types that return SellingPlanGroup

• [DeliveryProfile.sellingPlanGroups](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile#sellingplangroups-2021-01)
• [QueryRoot.sellingPlanGroup](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#sellingplangroup-2021-01)
• [QueryRoot.sellingPlanGroups](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#sellingplangroups-2021-01)

Mutations for SellingPlanGroup

• sellingPlanGroupAddProductVariants
  Adds multiple product variants to a selling plan group.
• sellingPlanGroupAddProducts
  Adds multiple products to a selling plan group.
• sellingPlanGroupCreate
  Creates a Selling Plan Group.
• sellingPlanGroupDelete
  Delete a Selling Plan Group.
• sellingPlanGroupRemoveProductVariants
  Removes multiple product variants from a selling plan group.
• sellingPlanGroupRemoveProducts
  Removes multiple products from a selling plan group.
• sellingPlanGroupUpdate
  Update a Selling Plan Group.

Implements

• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

An auto-generated type for paginating through multiple SellingPlanGroups.

On this page

• Fields

Fields

• edges ([[SellingPlanGroupEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
  A list of edges.
• pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
  Information to aid in pagination.

An auto-generated type which holds one SellingPlanGroup and a cursor during pagination.

On this page

• Fields
• Types that return SellingPlanGroupEdge

Fields

• cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A cursor for use in pagination.
• node ([SellingPlanGroup!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
  The item at the end of SellingPlanGroupEdge.

Types that return SellingPlanGroupEdge

• [SellingPlanGroupConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup#edges-2021-01)