SellingPlan

object

Requires read_products access scope.

Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

For more information on selling plans, refer to Creating and managing selling plans.

Anchor to Fields and connectionsFields and connections

Anchor to billingPolicybillingPolicy • SellingPlanBillingPolicy!non-null: A selling plan policy which describes the recurring billing details.
Anchor to categorycategory • SellingPlanCategory: The category used to classify the selling plan for reporting purposes.
Anchor to createdAtcreatedAt • DateTime!non-null: The date and time when the selling plan was created.
Anchor to deliveryPolicydeliveryPolicy • SellingPlanDeliveryPolicy!non-null: A selling plan policy which describes the delivery details.
Anchor to descriptiondescription • String: Buyer facing string which describes the selling plan commitment.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to inventoryPolicyinventoryPolicy • SellingPlanInventoryPolicy: When to reserve inventory for a selling plan.
Anchor to metafieldmetafield • Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields • MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename • String!non-null: A customer-facing description of the selling plan.

If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.
Anchor to optionsoptions • [String!]!non-null: The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
Anchor to positionposition • Int: Relative position of the selling plan for display. A lower position will be displayed before a higher position.
Anchor to pricingPoliciespricingPolicies • [SellingPlanPricingPolicy!]!non-null: Selling plan pricing details.
Anchor to translationstranslations • [Translation!]!non-null: The published translations associated with the resource.

Show

deprecated fields and connections Deprecated

Anchor to metafieldDefinitionsmetafieldDefinitions • MetafieldDefinitionConnection!non-nullDeprecated: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
Anchor to privateMetafieldprivateMetafield • PrivateMetafieldDeprecated: Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
Anchor to privateMetafieldsprivateMetafields • PrivateMetafieldConnection!non-nullDeprecated: List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasMetafieldDefinitions HasMetafieldDefinitions • interface
Anchor to HasMetafields HasMetafields • interface
Anchor to HasPublishedTranslations HasPublishedTranslations • interface
Anchor to Node Node • interface

Was this section helpful?