Selling
Requires access scope.
Represents deferred or recurring purchase options for
products and product variants,
such as subscriptions, pre-orders, or try-before-you-buy. Each selling plan belongs to a
and defines billing, pricing, inventory, and delivery policies.
Anchor to FieldsFields
- billingPolicy (SellingPlanBillingPolicy)
- checkoutCharge (SellingPlanCheckoutCharge!)
- deliveryPolicy (SellingPlanDeliveryPolicy)
- description (String)
- id (ID!)
- metafield (Metafield)
- metafields ([Metafield]!)
- name (String!)
- options ([SellingPlanOption!]!)
- priceAdjustments ([SellingPlanPriceAdjustment!]!)
- recurringDeliveries (Boolean!)
- Anchor to billingPolicybilling•Selling
Policy Plan Billing Policy The billing policy for the selling plan.
Show union types
- Anchor to checkoutChargecheckout•Selling
Charge Plan Checkout Charge! non-null The initial payment due for the purchase.
Show fields
- Anchor to deliveryPolicydelivery•Selling
Policy Plan Delivery Policy The delivery policy for the selling plan.
Show union types
- Anchor to descriptiondescription•String
The description of the selling plan.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•MetafieldToken access required
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.Show fields
- •String!required
The identifier for the metafield.
- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Arguments
- •String!
- Anchor to metafieldsmetafields•[Metafield]!non-null Token access required
A list of custom fields that a merchant associates with a Shopify resource.
Show fields
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
The input must not contain more than
250values.Show input fields
Arguments
- Anchor to namename•String!non-null
The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.
- Anchor to optionsoptions•[Selling
Plan Option!]! non-null The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called
option1: Delivery every. One selling plan in that group could contributeoption1: 2 weekswith the pricing for that option, and another selling plan could contributeoption1: 4 weeks, with different pricing.Show fields
- Anchor to priceAdjustmentsprice•[Selling
Adjustments Plan Price Adjustment!]! non-null The price adjustments that a selling plan makes when a variant is purchased with a selling plan.
Show fields
- Anchor to recurringDeliveriesrecurring•Boolean!
Deliveries non-null Whether purchasing the selling plan will result in multiple deliveries.