Selling
Requires access scope.
Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every three months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing policies, and delivery 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
The fixed selling plan billing policy defines how much of the price of the product will be billed to customer at checkout. If there is an outstanding balance, it determines when it will be paid.
- Anchor to checkoutChargecheckout•Selling
Charge Plan Checkout Charge! non-null The checkout charge when the full amount isn't charged at checkout.
- Anchor to remainingBalanceChargeExactTimeremaining•Date
Balance Charge Exact Time Time The exact time when to capture the full payment.
- Anchor to remainingBalanceChargeTimeAfterCheckoutremaining•String
Balance Charge Time After Checkout The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration.
- Anchor to remainingBalanceChargeTriggerremaining•Selling
Balance Charge Trigger Plan Remaining Balance Charge Trigger! non-null When to capture payment for amount due.
- •OBJECT
Represents a recurring selling plan billing policy.
- Anchor to anchorsanchors•[Selling
Plan Anchor!]! non-null Specific anchor dates upon which the billing interval calculations should be made.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the selling plan billing policy was created.
- Anchor to intervalinterval•Selling
Plan Interval! non-null The billing frequency, it can be either: day, week, month or year.
- Anchor to intervalCountinterval•Int!
Count non-null The number of intervals between billings.
- Anchor to maxCyclesmax•Int
Cycles Maximum number of billing iterations.
- Anchor to minCyclesmin•Int
Cycles Minimum number of billing iterations.
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.