API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

SellingPlanGroup object

Version unstable

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.

Connections

  • productVariants (ProductVariantConnection!)

    Product variants associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    productId ( ID )

    Filters the product variants by a product ID.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • products (ProductConnection!)

    Products associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • sellingPlans (SellingPlanConnection!)

    Selling plans associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appId (String)

    The identifier for app, exposed in Liquid and product JSON.

  • appliesToProduct (Boolean!)

    Whether the given product is directly associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • appliesToProductVariant (Boolean!)

    Whether the given product variant is directly associated to the selling plan group.

    Argument Description
    productVariantId ( ID! ) required

    The ID of the product.

  • appliesToProductVariants (Boolean!)

    Whether any of the product variants of the given product are associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • createdAt (DateTime!)

    The date and time when the selling plan group was created.

  • description (String)

    The merchant-facing description of the selling plan group.

  • id (ID!)

    Globally unique identifier.

  • merchantCode (String!)

    The merchant-facing label of the selling plan group.

  • name (String!)

    The buyer-facing label of the selling plan group.

  • options ([String!]!)

    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)

    The relative position of the selling plan group for display.

  • productCount (Int!)

    A count of products associated to the selling plan group.

  • productVariantCount (Int!)

    A count of product variants associated to the selling plan group.

    Argument Description
    productId ( ID )

    The ID of the product to scope the count to.

  • summary (String)

    A summary of the policies associated to the selling plan group.

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Implements

Version unstable

An auto-generated type for paginating through multiple SellingPlanGroups.

Fields

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Version unstable

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

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of SellingPlanGroupEdge.

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Version 2021-07 (Release candidate)

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.

Connections

  • productVariants (ProductVariantConnection!)

    Product variants associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    productId ( ID )

    Filters the product variants by a product ID.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • products (ProductConnection!)

    Products associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • sellingPlans (SellingPlanConnection!)

    Selling plans associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appId (String)

    The identifier for app, exposed in Liquid and product JSON.

  • appliesToProduct (Boolean!)

    Whether the given product is directly associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • appliesToProductVariant (Boolean!)

    Whether the given product variant is directly associated to the selling plan group.

    Argument Description
    productVariantId ( ID! ) required

    The ID of the product.

  • appliesToProductVariants (Boolean!)

    Whether any of the product variants of the given product are associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • createdAt (DateTime!)

    The date and time when the selling plan group was created.

  • description (String)

    The merchant-facing description of the selling plan group.

  • id (ID!)

    Globally unique identifier.

  • merchantCode (String!)

    The merchant-facing label of the selling plan group.

  • name (String!)

    The buyer-facing label of the selling plan group.

  • options ([String!]!)

    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)

    The relative position of the selling plan group for display.

  • productCount (Int!)

    A count of products associated to the selling plan group.

  • productVariantCount (Int!)

    A count of product variants associated to the selling plan group.

    Argument Description
    productId ( ID )

    The ID of the product to scope the count to.

  • summary (String)

    A summary of the policies associated to the selling plan group.

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Implements

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple SellingPlanGroups.

On this page

Fields

Version 2021-07 (Release candidate)

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

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of SellingPlanGroupEdge.

Types that return SellingPlanGroupEdge

Version 2021-04 (Latest)

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.

Connections

  • productVariants (ProductVariantConnection!)

    Product variants associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    productId ( ID )

    Filters the product variants by a product ID.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • products (ProductConnection!)

    Products associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • sellingPlans (SellingPlanConnection!)

    Selling plans associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appId (String)

    The identifier for app, exposed in Liquid and product JSON.

  • appliesToProduct (Boolean!)

    Whether the given product is directly associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • appliesToProductVariant (Boolean!)

    Whether the given product variant is directly associated to the selling plan group.

    Argument Description
    productVariantId ( ID! ) required

    The ID of the product.

  • appliesToProductVariants (Boolean!)

    Whether any of the product variants of the given product are associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • createdAt (DateTime!)

    The date and time when the selling plan group was created.

  • description (String)

    The merchant-facing description of the selling plan group.

  • id (ID!)

    Globally unique identifier.

  • merchantCode (String!)

    The merchant-facing label of the selling plan group.

  • name (String!)

    The buyer-facing label of the selling plan group.

  • options ([String!]!)

    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)

    The relative position of the selling plan group for display.

  • productCount (Int!)

    A count of products associated to the selling plan group.

  • productVariantCount (Int!)

    A count of product variants associated to the selling plan group.

    Argument Description
    productId ( ID )

    The ID of the product to scope the count to.

  • summary (String)

    A summary of the policies associated to the selling plan group.

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Implements

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple SellingPlanGroups.

On this page

Fields

Version 2021-04 (Latest)

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

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of SellingPlanGroupEdge.

Types that return SellingPlanGroupEdge

Version 2021-01

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.

Connections

  • productVariants (ProductVariantConnection!)

    Product variants associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    productId ( ID )

    Filters the product variants by a product ID.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • products (ProductConnection!)

    Products associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • sellingPlans (SellingPlanConnection!)

    Selling plans associated to the selling plan group.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appId (String)

    The identifier for app, exposed in Liquid and product JSON.

  • appliesToProduct (Boolean!)

    Whether the given product is directly associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • appliesToProductVariant (Boolean!)

    Whether the given product variant is directly associated to the selling plan group.

    Argument Description
    productVariantId ( ID! ) required

    The ID of the product.

  • appliesToProductVariants (Boolean!)

    Whether any of the product variants of the given product are associated to the selling plan group.

    Argument Description
    productId ( ID! ) required

    The ID of the product.

  • createdAt (DateTime!)

    The date and time when the selling plan group was created.

  • description (String)

    The merchant-facing description of the selling plan group.

  • id (ID!)

    Globally unique identifier.

  • merchantCode (String!)

    The merchant-facing label of the selling plan group.

  • name (String!)

    The buyer-facing label of the selling plan group.

  • options ([String!]!)

    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)

    The relative position of the selling plan group for display.

  • productCount (Int!)

    A count of products associated to the selling plan group.

  • productVariantCount (Int!)

    A count of product variants associated to the selling plan group.

    Argument Description
    productId ( ID )

    The ID of the product to scope the count to.

  • summary (String)

    A summary of the policies associated to the selling plan group.

Types that return SellingPlanGroup

Mutations for SellingPlanGroup

Implements

Version 2021-01

An auto-generated type for paginating through multiple SellingPlanGroups.

On this page

Fields

Version 2021-01

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

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of SellingPlanGroupEdge.

Types that return SellingPlanGroupEdge