Choose a version:

subscriptionDraft

query

Returns a Subscription Draft resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the Subscription Draft to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to SubscriptionDraftSubscriptionDraft

•SubscriptionDraft

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.

Anchor to billingCyclebillingCycle

•SubscriptionBillingCycle

The billing cycle that the subscription contract will be associated with.

Anchor to billingPolicybillingPolicy

•SubscriptionBillingPolicy!

non-null

The billing policy for the subscription contract.

Anchor to concatenatedBillingCyclesconcatenatedBillingCycles

•SubscriptionBillingCycleConnection!

non-null

The billing cycles of the contracts that will be concatenated to the subscription contract.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•SubscriptionBillingCyclesSortKeys

Default:CYCLE_INDEX

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The currency used for the subscription contract.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

A list of the custom attributes to be added to the generated orders.

Anchor to customercustomer

•Customer!

non-null

The customer to whom the subscription contract belongs.

Anchor to customerPaymentMethodcustomerPaymentMethod

•CustomerPaymentMethod

The customer payment method used for the subscription contract.

Anchor to showRevokedshowRevoked •Boolean Default:false: Whether to show the customer's revoked payment method.

Anchor to deliveryMethoddeliveryMethod

•SubscriptionDeliveryMethod

The delivery method for each billing of the subscription contract.

Anchor to deliveryOptionsdeliveryOptions

•SubscriptionDeliveryOptionResult

The available delivery options for a given delivery address. Returns null for pending requests.

Anchor to deliveryPolicydeliveryPolicy

•SubscriptionDeliveryPolicy!

non-null

The delivery policy for the subscription contract.

Anchor to deliveryPricedeliveryPrice

•MoneyV2

The delivery price for each billing the subscription contract.

Anchor to discountsdiscounts

•SubscriptionDiscountConnection!

non-null

The list of subscription discounts which will be associated with the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to discountsAddeddiscountsAdded

•SubscriptionDiscountConnection!

non-null

The list of subscription discounts to be added to the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to discountsRemoveddiscountsRemoved

•SubscriptionDiscountConnection!

non-null

The list of subscription discounts to be removed from the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to discountsUpdateddiscountsUpdated

•SubscriptionDiscountConnection!

non-null

The list of subscription discounts to be updated on the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to lineslines

•SubscriptionLineConnection!

non-null

The list of subscription lines which will be associated with the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to linesAddedlinesAdded

•SubscriptionLineConnection!

non-null

The list of subscription lines to be added to the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to linesRemovedlinesRemoved

•SubscriptionLineConnection!

non-null

The list of subscription lines to be removed from the subscription contract.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to nextBillingDatenextBillingDate

•DateTime

The next billing date for the subscription contract.

Anchor to notenote

•String

The note field that will be applied to the generated orders.

Anchor to originalContractoriginalContract

•SubscriptionContract

The original subscription contract.

Anchor to statusstatus

•SubscriptionContractSubscriptionStatus

The current status of the subscription contract.

Anchor to shippingOptionsshippingOptions

•SubscriptionShippingOptionResult

Deprecated

Was this section helpful?