API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

SellingPlan object

Version unstable

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.

Required access

Requires access to either all or app-owned 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

Implements

Version unstable

An auto-generated type for paginating through multiple SellingPlans.

Fields

Types that return SellingPlan

Version unstable

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

Version 2021-07 (Release candidate)

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.

Required access

Requires access to either all or app-owned 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

Implements

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple SellingPlans.

On this page

Fields

Version 2021-07 (Release candidate)

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

Version 2021-04 (Latest)

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.

Required access

Requires access to either all or app-owned 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

Implements

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple SellingPlans.

On this page

Fields

Version 2021-04 (Latest)

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

Version 2021-01

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.

Required access

Requires access to either all or app-owned 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

Implements

Version 2021-01

An auto-generated type for paginating through multiple SellingPlans.

On this page

Fields

Version 2021-01

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