Skip to main content
Anchor to SubscriptionDeliveryOptionResult

SubscriptionDeliveryOptionResult

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

The result of the query to fetch delivery options for the subscription contract.

Anchor to Possible typesPossible types

Anchor to SubscriptionDeliveryOptionResultFailureSubscriptionDeliveryOptionResultFailure
•OBJECT

A failure to find the available delivery options for a subscription contract.

Anchor to messagemessage
•String

The reason for the failure.

Anchor to SubscriptionDeliveryOptionResultSuccessSubscriptionDeliveryOptionResultSuccess
•OBJECT

The delivery option for a subscription contract.

Anchor to deliveryOptionsdeliveryOptions
•[SubscriptionDeliveryOption!]!
non-null

The available delivery options.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to SubscriptionDraft.deliveryOptionsSubscriptionDraft.deliveryOptions
•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?