SubscriptionDraft object

Represents a Subscription Draft.

Required access

read_own_subscription_contracts access scope.

On this page

• Connections
• Fields
• Types that return SubscriptionDraft
• Mutations for SubscriptionDraft
• Implements

Connections

• discounts ([SubscriptionDiscountConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscount))
  The list of subscription discounts which will be associated with the subscription contract.

• discountsAdded ([SubscriptionDiscountConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscount))
  The list of subscription discounts to be added to the subscription contract.

• discountsRemoved ([SubscriptionDiscountConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscount))
  The list of subscription discounts to be removed from the subscription contract.

• discountsUpdated ([SubscriptionDiscountConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondiscount))
  The list of subscription discounts to be updated on the subscription contract.

• lines ([SubscriptionLineConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionline))
  The list of subscription lines which will be associated with the subscription contract.

• linesAdded ([SubscriptionLineConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionline))
  The list of subscription lines to be added to the subscription contract.

• linesRemoved ([SubscriptionLineConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionline))
  The list of subscription lines to be removed from the subscription contract.

Fields

• billingPolicy ([SubscriptionBillingPolicy!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingpolicy))
  The billing policy for the subscription contract.
• currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode))
  The currency used for the subscription contract.
• customer ([Customer!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
  The customer to whom the subscription contract belongs.
• customerPaymentMethod ([CustomerPaymentMethod](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod))
  The customer payment method used for the subscription contract.

• deliveryMethod ([SubscriptionDeliveryMethod](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondeliverymethod))
  The delivery method for each billing of the subscription contract.
• deliveryPolicy ([SubscriptionDeliveryPolicy!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondeliverypolicy))
  The delivery policy for the subscription contract.
• deliveryPrice ([MoneyV2](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
  The delivery price for each billing the subscription contract.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• nextBillingDate ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The next billing date for the subscription contract.
• originalContract ([SubscriptionContract](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
  The original subscription contract.
• shippingOptions ([SubscriptionShippingOptionResult](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionshippingoptionresult))
  Available Shipping Options for a given delivery address. Returns NULL for pending requests.

• status ([SubscriptionContractSubscriptionStatus](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontractsubscriptionstatus))
  The current status of the subscription contract.

Types that return SubscriptionDraft

• [QueryRoot.subscriptionDraft](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#subscriptiondraft-2021-01)

Mutations for SubscriptionDraft

• subscriptionDraftCommit
  Commits the updates of a Subscription Contract draft.
• subscriptionDraftDiscountAdd
  Adds a subscription discount to a subscription draft.
• subscriptionDraftDiscountCodeApply
  Applies a code discount on the subscription draft.
• subscriptionDraftDiscountRemove
  Removes a subscription discount from a subscription draft.
• subscriptionDraftDiscountUpdate
  Updates a subscription discount on a subscription draft.
• subscriptionDraftFreeShippingDiscountAdd
  Adds a subscription free shipping discount to a subscription draft.
• subscriptionDraftFreeShippingDiscountUpdate
  Updates a subscription free shipping discount on a subscription draft.
• subscriptionDraftLineAdd
  Adds a subscription line to a subscription draft.
• subscriptionDraftLineRemove
  Removes a subscription line from a subscription draft.
• subscriptionDraftLineUpdate
  Updates a subscription line on a subscription draft.
• subscriptionDraftUpdate
  Updates a Subscription Draft.

Implements

• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)