GitHub

ShopifySellingPlanAllocation

Type

import { ShopifySellingPlanAllocation } from '@daffodil/driver/shopify'

Links a ProductVariant to a SellingPlan, providing the pricing details for that specific combination. Each allocation includes the checkout charge amount, any remaining balance due for the purchase, and up to two price adjustments that show how the selling plan affects the variant's price.

Selling plan allocations are available on product variants and cart lines, enabling storefronts to display information such as subscription or purchase option pricing before and during checkout.

interface ShopifySellingPlanAllocation {
  __typename: "SellingPlanAllocation"
  checkoutChargeAmount: ShopifyMoneyV2
  priceAdjustments: ShopifySellingPlanAllocationPriceAdjustment[]
  remainingBalanceChargeAmount: ShopifyMoneyV2
  sellingPlan: ShopifySellingPlan
}

Properties

__typename
"SellingPlanAllocation"
checkoutChargeAmount
ShopifyMoneyV2

The checkout charge amount due for the purchase.

priceAdjustments
ShopifySellingPlanAllocationPriceAdjustment[]

A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it.

remainingBalanceChargeAmount
ShopifyMoneyV2

The remaining balance charge amount due for the purchase.

sellingPlan
ShopifySellingPlan

A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.