ShopifySellingPlan

interface

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

Represents how products and variants can be sold and purchased.

interface ShopifySellingPlan {
  __typename: "SellingPlan"
  checkoutCharge: ShopifySellingPlanCheckoutCharge
  description: string
  id: string
  name: string
  options: ShopifySellingPlanOption[]
  priceAdjustments: ShopifySellingPlanPriceAdjustment[]
  recurringDeliveries: boolean
}

Properties

__typename `"SellingPlan"`

checkoutCharge `ShopifySellingPlanCheckoutCharge`
The initial payment due for the purchase.

description `string`
The description of the selling plan.

id `string`
A globally-unique ID.

name `string`
The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

options `ShopifySellingPlanOption[]`
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 contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing.

options

ShopifySellingPlanOption[]

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 contribute option1: 2 weeks with the pricing for that option, and another selling plan could contribute option1: 4 weeks, with different pricing.

priceAdjustments `ShopifySellingPlanPriceAdjustment[]`
The price adjustments that a selling plan makes when a variant is purchased with a selling plan.

recurringDeliveries `boolean`
Whether purchasing the selling plan will result in multiple deliveries.