Subscription Delivery Method
Requires the or
scope.
Describes the delivery method to use to get the physical goods to the customer.
Anchor to Possible typesPossible types
- •OBJECT
A subscription delivery method for local delivery. The other subscription delivery methods can be found in the
union type.
- Anchor to addressaddress•Mailing
Address! non-null The address to deliver to.
- Anchor to localDeliveryOptionlocal•Subscription
Delivery Option Delivery Method Local Delivery Option! non-null The details of the local delivery method to use.
- •OBJECT
A delivery method with a pickup option.
- Anchor to pickupOptionpickup•Subscription
Option Delivery Method Pickup Option! non-null The details of the pickup delivery method to use.
- •OBJECT
Represents a shipping delivery method: a mailing address and a shipping option.
- Anchor to addressaddress•Mailing
Address! non-null The address to ship to.
- Anchor to shippingOptionshipping•Subscription
Option Delivery Method Shipping Option! non-null The details of the shipping method to use.
Anchor to Fields with this unionFields with this union
- Anchor to SubscriptionBillingCycleEditedContract.deliveryMethodSubscription•OBJECT
Billing Cycle Edited Contract. delivery Method Represents a subscription contract with billing cycles.
- •OBJECT
Represents a Subscription Contract.
- •INTERFACE
Represents subscription contract common fields.
- •OBJECT
The
object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.
Use the
object to:
- Add, remove, or modify subscription lines and their quantities
- Manage discounts (add, remove, or update manual and code-based discounts)
- Configure delivery options and shipping methods
- Set up billing and delivery policies
- Manage customer payment methods
- Add custom attributes and notes to generated orders
- Configure billing cycles and next billing dates
- Preview the projected state of the subscription
Each
object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.
The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.
Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.