SellingPlan
Requires 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 FieldsFields
- Anchor to billingPolicybilling•
Policy SellingPlan non-nullBilling Policy! A selling plan policy which describes the recurring billing details.
- Anchor to categorycategory•
The category used to classify the selling plan for reporting purposes.
- Anchor to createdAtcreated•
At DateTime! non-null The date and time when the selling plan was created.
- Anchor to deliveryPolicydelivery•
Policy SellingPlan non-nullDelivery Policy! A selling plan policy which describes the delivery details.
- Anchor to descriptiondescription•
Buyer facing string which describes the selling plan commitment.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryPolicyinventory•
Policy When to reserve inventory for a selling plan.
- 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
andvalues.- Anchor to positionposition•
Relative position of the selling plan for display. A lower position will be displayed before a higher position.
- Anchor to pricingPoliciespricing•
Policies [SellingPlan non-nullPricing Policy!]! Selling plan pricing details.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.