Selling
Requires access scope.
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.
Anchor to Fields and connectionsFields and connections
- Anchor to appIdapp•String
Id The ID for app, exposed in Liquid and product JSON.
- Anchor to appliesToProductapplies•Boolean!non-null
To Product Whether the given product is directly associated to the selling plan group.
- Anchor to appliesToProductVariantapplies•Boolean!non-null
To Product Variant Whether the given product variant is directly associated to the selling plan group.
- Anchor to appliesToProductVariantsapplies•Boolean!non-null
To Product Variants Whether any of the product variants of the given product are associated to the selling plan group.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the selling plan group was created.
- Anchor to descriptiondescription•String
The merchant-facing description of the selling plan group.
- •ID!non-null
A globally-unique ID.
- Anchor to merchantCodemerchant•String!non-null
Code The merchant-facing label of the selling plan group.
- Anchor to namename•String!non-null
The buyer-facing label of the selling plan group.
- Anchor to optionsoptions•[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
andvalues.- Anchor to positionposition•Int
The relative position of the selling plan group for display.
- Anchor to productsproducts•Product
Connection!non-null Products associated to the selling plan group.
- Anchor to productsCountproducts•Count
Count A count of products associated to the selling plan group.
- Anchor to productVariantsproduct•Product
Variants Variant Connection!non-null Product variants associated to the selling plan group.
- Anchor to productVariantsCountproduct•Count
Variants Count A count of product variants associated to the selling plan group.
- Anchor to sellingPlansselling•Selling
Plans Plan Connection!non-null Selling plans associated to the selling plan group.
- Anchor to summarysummary•String
A summary of the policies associated to the selling plan group.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
Anchor to QueriesQueries
- •query
Returns a Selling Plan Group resource by ID.
- •query
List Selling Plan Groups.
Anchor to MutationsMutations
- •mutation
Adds multiple products to a selling plan group.
- •ID!required
The ID of the selling plan group.
- Anchor to productIdsproduct•[ID!]!required
Ids The IDs of the products to add.
Arguments
- Anchor to sellingPlanGroupselling•Selling
Plan Group Plan Group The updated selling plan group.
- Anchor to userErrorsuser•[Selling
Errors Plan Group User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds multiple product variants to a selling plan group.
- •ID!required
The ID of the selling plan group.
- Anchor to productVariantIdsproduct•[ID!]!required
Variant Ids The IDs of the product variants to add.
Arguments
- Anchor to sellingPlanGroupselling•Selling
Plan Group Plan Group The updated selling plan group.
- Anchor to userErrorsuser•[Selling
Errors Plan Group User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a Selling Plan Group.
- Anchor to inputinput•Selling
Plan Group Input!required The properties of the new Selling Plan Group.
- Anchor to resourcesresources•Selling
Plan Group Resource Input The resources this Selling Plan Group should be applied to.
Arguments
- Anchor to sellingPlanGroupselling•Selling
Plan Group Plan Group The created selling plan group object.
- Anchor to userErrorsuser•[Selling
Errors Plan Group User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update a Selling Plan Group.
- •ID!required
The Selling Plan Group to update.
- Anchor to inputinput•Selling
Plan Group Input!required The properties of the Selling Plan Group to update.
Arguments
- Anchor to deletedSellingPlanIdsdeleted•[ID!]
Selling Plan Ids The IDs of the deleted Subscription Plans.
- Anchor to sellingPlanGroupselling•Selling
Plan Group Plan Group The updated Selling Plan Group.
- Anchor to userErrorsuser•[Selling
Errors Plan Group User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields