Selling
Requires access scope.
Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans, pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
Anchor to Possible typesPossible types
- •OBJECT
Represents a fixed selling plan delivery policy.
- Anchor to anchorsanchors•[Selling
Plan Anchor!]! non-null The specific anchor dates upon which the delivery interval calculations should be made.
- Anchor to cutoffcutoff•Int
A buffer period for orders to be included in next fulfillment anchor.
- Anchor to fulfillmentExactTimefulfillment•Date
Exact Time Time The date and time when the fulfillment should trigger.
- Anchor to fulfillmentTriggerfulfillment•Selling
Trigger Plan Fulfillment Trigger! non-null What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.
- Anchor to intentintent•Selling
Plan Fixed Delivery Policy Intent! non-null Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
- Anchor to preAnchorBehaviorpre•Selling
Anchor Behavior Plan Fixed Delivery Policy Pre Anchor Behavior! non-null The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is
.
- •OBJECT
Represents a recurring selling plan delivery policy.
- Anchor to anchorsanchors•[Selling
Plan Anchor!]! non-null The specific anchor dates upon which the delivery interval calculations should be made.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the selling plan delivery policy was created.
- Anchor to cutoffcutoff•Int
Number of days which represent a buffer period for orders to be included in a cycle.
- Anchor to intentintent•Selling
Plan Recurring Delivery Policy Intent! non-null Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
- Anchor to intervalinterval•Selling
Plan Interval! non-null The delivery frequency, it can be either: day, week, month or year.
- Anchor to intervalCountinterval•Int!
Count non-null The number of intervals between deliveries.
- Anchor to preAnchorBehaviorpre•Selling
Anchor Behavior Plan Recurring Delivery Policy Pre Anchor Behavior! non-null The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is
.
Anchor to Fields with this unionFields with this union
- •OBJECT
How a product can be sold and purchased through recurring billing or deferred purchase options. Defines the specific terms for subscriptions, pre-orders, or try-before-you-buy offers, including when to bill customers, when to fulfill orders, and what pricing adjustments to apply.
Each selling plan has billing, delivery, and pricing policies that control the purchase experience. The plan's
optionsandcategoryhelp merchants organize and report on different selling strategies. Plans are grouped within athat associates them withProductandobjects.CautionSelling plans and associated records are automatically deleted 48 hours after a merchant uninstalls the
Appthat created them. Back up these records if you need to restore them later.Learn more about selling plans.