SellingPlan object

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.

Fields

• billingPolicy (SellingPlanBillingPolicy!)

  Selling plan policy which describes the billing details.

• createdAt (DateTime!)

  The date and time when the selling plan was created.

• deliveryPolicy (SellingPlanDeliveryPolicy!)

  Selling plan policy which describes the delivery details.

• description (String)

  Buyer facing string which describes the selling plan commitment.

• id (ID!)

  Globally unique identifier.

• name (String!)

  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.

• options ([String!]!)

  The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

• position (Int)

  Relative position of the selling plan for display. A lower position will be displayed before a higher position.

• pricingPolicies ([SellingPlanPricingPolicy!]!)

  Selling plan pricing details.

Types that return SellingPlan

• SellingPlan.node
• SellingPlanGroup.sellingPlans

Implements

• Node

An auto-generated type for paginating through multiple SellingPlans.

Fields

• edges ([SellingPlanEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

Types that return SellingPlan

• SellingPlan.node
• SellingPlanGroup.sellingPlans

An auto-generated type which holds one SellingPlan and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (SellingPlan!)

  The item at the end of SellingPlanEdge.

Types that return SellingPlan

• SellingPlan.node
• SellingPlanGroup.sellingPlans

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.

Fields

• billingPolicy (SellingPlanBillingPolicy!)

  Selling plan policy which describes the billing details.

• createdAt (DateTime!)

  The date and time when the selling plan was created.

• deliveryPolicy (SellingPlanDeliveryPolicy!)

  Selling plan policy which describes the delivery details.

• description (String)

  Buyer facing string which describes the selling plan commitment.

• id (ID!)

  Globally unique identifier.

• name (String!)

  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.

• options ([String!]!)

  The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

• position (Int)

  Relative position of the selling plan for display. A lower position will be displayed before a higher position.

• pricingPolicies ([SellingPlanPricingPolicy!]!)

  Selling plan pricing details.

Types that return SellingPlan

• SellingPlanGroup.sellingPlans

Implements

• Node

An auto-generated type for paginating through multiple SellingPlans.

Fields

• edges ([SellingPlanEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one SellingPlan and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (SellingPlan!)

  The item at the end of SellingPlanEdge.

Types that return SellingPlanEdge

• SellingPlanConnection.edges