Choose a version:

SellingPlanDeliveryPolicy

union

Requires read_products 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

SellingPlanFixedDeliveryPolicy

•OBJECT

Represents a fixed selling plan delivery policy.

Anchor to anchorsanchors •[SellingPlanAnchor!]! 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 fulfillmentExactTimefulfillmentExactTime •DateTime: The date and time when the fulfillment should trigger.
Anchor to fulfillmentTriggerfulfillmentTrigger •SellingPlanFulfillmentTrigger! non-null: What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.
Anchor to intentintent •SellingPlanFixedDeliveryPolicyIntent! 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 preAnchorBehaviorpreAnchorBehavior •SellingPlanFixedDeliveryPolicyPreAnchorBehavior! 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 ASAP.

SellingPlanRecurringDeliveryPolicy

•OBJECT

Represents a recurring selling plan delivery policy.

Anchor to anchorsanchors •[SellingPlanAnchor!]! non-null: The specific anchor dates upon which the delivery interval calculations should be made.
Anchor to createdAtcreatedAt •DateTime! 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 •SellingPlanRecurringDeliveryPolicyIntent! 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 •SellingPlanInterval! non-null: The delivery frequency, it can be either: day, week, month or year.
Anchor to intervalCountintervalCount •Int! non-null: The number of intervals between deliveries.
Anchor to preAnchorBehaviorpreAnchorBehavior •SellingPlanRecurringDeliveryPolicyPreAnchorBehavior! 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 ASAP.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to SellingPlan.deliveryPolicy SellingPlan.deliveryPolicy •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.

Was this section helpful?