Skip to main content
Anchor to SubscriptionDeliveryMethod

SubscriptionDeliveryMethod

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Describes the delivery method to use to get the physical goods to the customer.

•OBJECT

A subscription delivery method for local delivery. The other subscription delivery methods can be found in the SubscriptionDeliveryMethod union type.

•MailingAddress!
non-null

The address to deliver to.

•SubscriptionDeliveryMethodLocalDeliveryOption!
non-null

The details of the local delivery method to use.

•OBJECT

A delivery method with a pickup option.

•SubscriptionDeliveryMethodPickupOption!
non-null

The details of the pickup delivery method to use.

•OBJECT

Represents a shipping delivery method: a mailing address and a shipping option.

•MailingAddress!
non-null

The address to ship to.

•SubscriptionDeliveryMethodShippingOption!
non-null

The details of the shipping method to use.


Was this section helpful?

Anchor to Fields with this unionFields with this union

•INTERFACE

Represents subscription contract common fields.

•OBJECT

The SubscriptionDraft 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 SubscriptionDraft 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 SubscriptionDraft 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.


Was this section helpful?