Manage subscription products on storefronts

You can use the Storefront API to retrieve subscription products on a storefront. Subscription products can be accessed from the sellingPlans object.

This tutorial shows you how to use the Storefront API to retrieve information about selling plans, including price adjustments and selling plan allocations. It also shows how to create a cart with a subscription line item.

Requirements

To use the GraphQL queries, your app must enable the selling_plans_in_storefront_api beta flag and request the unauthenticated_read_selling_plans access scope for a Shopify store.

Limitations and considerations

Retrieving subscription products isn't supported using the checkout workflow. You must use the cart workflow to retrieve subscription products.

How selling plans work

Selling plans represent how products and variants can be sold and purchased. A selling plan group contains selling plans and represents a selling method. For example, "Subscribe and save" is a selling method where customers pay for goods or services per delivery.

When a customer makes a purchase on a storefront, they're buying a variant. Each variant is associated with a price. The variant's price can be adjusted based on an applied fixed or percentage discount, and whether it's purchased with a selling plan.

A selling plan allocation associates a variant with a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

Diagram showing relationships between a selling plan group, products, variants, and selling plans

Query selling plans for a product

To retrieve information about selling plans, query a product by its handle (productByHandle). The sellingPlanGroups object associated with the product contains the individual selling plans, which include information such as delivery frequencies.

Individual selling plans

Within the sellingPlans object, you can query the selling plan ID. This ID is used to identify which selling plan a customer has picked when they add a subscription product to their cart. You can also query whether purchasing the selling plan will result in multiple deliveries (recurringDeliveries).

The options field represents the selling plan options available in the drop-down list in the storefront.

Example

The following example shows how to query a selling plan group associated with a product, and its individual selling plans. The requiresSellingPlan field is true, which means that the product can be purchased only as part of a selling plan.

Individual selling plans contribute their options to the associated selling plan group. In the following example, a selling plan group has an option called Delivery every. Each individual selling plan that belongs to the group contributes an option (1 week, 2 weeks, and 3 weeks) to the selling plan group.

POST /api/2021-07/graphql.json

View response

JSON response

Query price adjustments on variants

A product can have multiple variants and each variant can have up to two price adjustments. The priceAdjustments field represents how a selling plan affects pricing when a variant is purchased with a selling plan.

If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the orderCount field) are made.

If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price.

Price adjustment values

The adjustmentValue field represents the type of price adjustment.

A variant can have the following types of price adjustment values:

  • SellingPlanPercentagePriceAdjustment: A percentage amount deducted from the original variant price when it's purchased with a selling plan. For example, 10% off.
  • SellingPlanFixedAmountPriceAdjustment: A specific amount deducted from the original variant price when it's purchased with a selling plan. For example, 10.00 USD off.
  • SellingPlanFixedPriceAdjustment: A fixed price adjustment for a variant that's purchased with a selling plan. For example, if the selling plan offers a 10% discount on a variant that's regularly priced at 60.00 USD, then the price is 54.00 USD (60.00 USD x 0.90).

Example

The following example retrieves the price adjustment value types on a variant. The response shows a variant that has a 20% discount when it's purchased with a selling plan.

POST /api/2021-07/graphql.json

View response

JSON response

Query selling plan allocations and variant prices

A selling plan allocation describes the effect that each selling plan has on variants when they're purchased. It other words, it represents the combination of a variant and a selling plan.

Prices

Selling plan allocations contain the resulting prices for variants when they're purchased with a specific selling plan:

  • price: The price that's paid when the purchase is made. For example, for a prepaid plan for 6 deliveries of 10.00 USD granola, where the customer gets 20% off, the price is 6 x 10 USD x 0.80 = 48.00 USD.
  • compareAtPrice: The price of the variant when it's purchased without a selling plan for the same number of deliveries. For example, 6 deliveries x 10 USD granola = 60.00 USD.
  • perDeliveryPrice: The effective price for a single delivery. For example, for a prepaid plan for 6 deliveries, where the price is 48.00 USD, the per delivery price is 8.00 USD.
  • unitPrice: The unit price of the variant associated with the selling plan. For example, a merchant might sell a subscription product in quantities or measurements. If the variant has no unit price, then this field returns null.

Prices display in the customer's currency if the shop is configured for it. For example, if a customer in Canada tries to pay for a product on a storefront based in the United States, then prices display in CAD.

Example

The following query shows how to retrieve information about a variant associated with a selling plan. The response shows the prices of the variant.

Without the selling plan, the variant price is 60.00 CAD (compareAtPrice). If the variant is purchased with a selling plan that provides a 20% discount, then the price is 48.00 CAD. The perDeliveryPrice is determined the price (48.00 CAD) divided by the number of deliveries (6), which equals 8.00 CAD per delivery.

POST /api/2021-07/graphql.json

View response

JSON response

Create a cart and a subscription line item

You can use the cartCreate mutation to create a cart that contains the purchase of a variant with a selling plan. In your input to the mutation, provide the line item quantity, variant ID, and selling plan ID.

Example

In the following example, the response returns each cart line with the quantity, the variant (merchandise) purchased, and the selling plan that's associated with the variant.

The resulting prices for the variant when it's purchased with the selling plan are also returned.

POST /api/2021-10/graphql.json

Variables

View response

JSON response

Next steps