ShopifySellingPlan

Type

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

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 SellingPlanGroup and defines billing, pricing, inventory, and delivery policies.

interface ShopifySellingPlan {
  __typename: "SellingPlan"
  billingPolicy: ShopifySellingPlanRecurringBillingPolicy
  checkoutCharge: ShopifySellingPlanCheckoutCharge
  deliveryPolicy: ShopifySellingPlanRecurringDeliveryPolicy
  description: string
  id: string
  metafield: ShopifyMetafield
  metafields: ShopifyMetafield[]
  name: string
  options: ShopifySellingPlanOption[]
  priceAdjustments: ShopifySellingPlanPriceAdjustment[]
  recurringDeliveries: boolean
}

Properties

__typename `"SellingPlan"`

billingPolicy `ShopifySellingPlanRecurringBillingPolicy`
The billing policy for the selling plan.

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

deliveryPolicy `ShopifySellingPlanRecurringDeliveryPolicy`
The delivery policy for the selling plan.

description `string`
The description of the selling plan.

id `string`
A globally-unique ID.

metafield `ShopifyMetafield`
A custom field, including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.

metafields `ShopifyMetafield[]`
A list of custom fields that a merchant associates with a Shopify resource.

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.