---
title: subscriptionDraft - GraphQL Admin
description: Returns a Subscription Draft resource by ID.
api_version: 2025-01
api_name: admin
type: query
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/2025-01/queries/SubscriptionDraft
  md: https://shopify.dev/docs/api/admin-graphql/2025-01/queries/SubscriptionDraft.md
---

# subscription​Draft

query

Returns a Subscription Draft resource by ID.

## Arguments

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID)

  required

  The ID of the Subscription Draft to return.

***

## Possible returns

* Subscription​Draft

  [Subscription​Draft](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionDraft)

  The `SubscriptionDraft` object represents a draft version of a [subscription contract](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) 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](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts) and how to [build](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/build-a-subscription-contract), [update](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/update-a-subscription-contract), and [combine](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/combine-subscription-contracts) subscription contracts.

  * billing​Cycle

    [Subscription​Billing​Cycle](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionBillingCycle)

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

  * billing​Policy

    [Subscription​Billing​Policy!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionBillingPolicy)

    non-null

    The billing policy for the subscription contract.

  * concatenated​Billing​Cycles

    [Subscription​Billing​Cycle​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionBillingCycleConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    * sort​Key

      [Subscription​Billing​Cycles​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

    ***

  * currency​Code

    [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/CurrencyCode)

    non-null

    The currency used for the subscription contract.

  * custom​Attributes

    [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Attribute)

    non-null

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

  * customer

    [Customer!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Customer)

    non-null

    The customer to whom the subscription contract belongs.

  * customer​Payment​Method

    [Customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerPaymentMethod)

    The customer payment method used for the subscription contract.

    * show​Revoked

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      ### Arguments

      Whether to show the customer's revoked payment method.

    ***

  * delivery​Method

    [Subscription​Delivery​Method](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/SubscriptionDeliveryMethod)

    The delivery method for each billing of the subscription contract.

  * delivery​Options

    [Subscription​Delivery​Option​Result](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/SubscriptionDeliveryOptionResult)

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

  * delivery​Policy

    [Subscription​Delivery​Policy!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionDeliveryPolicy)

    non-null

    The delivery policy for the subscription contract.

  * delivery​Price

    [Money​V2](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyV2)

    The delivery price for each billing the subscription contract.

  * discounts

    [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionDiscountConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * discounts​Added

    [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionDiscountConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * discounts​Removed

    [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionDiscountConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * discounts​Updated

    [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionDiscountConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * id

    [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID)

    non-null

    A globally-unique ID.

  * lines

    [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionLineConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * lines​Added

    [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionLineConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * lines​Removed

    [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionLineConnection)

    non-null

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

    * first

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      ### Arguments

      The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * after

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * last

      [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int)

      The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

    * before

      [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

      The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

    * reverse

      [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean)

      Default:false

      Reverse the order of the underlying list.

    ***

  * next​Billing​Date

    [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime)

    The next billing date for the subscription contract.

  * note

    [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String)

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

  * original​Contract

    [Subscription​Contract](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionContract)

    The original subscription contract.

  * status

    [Subscription​Contract​Subscription​Status](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/SubscriptionContractSubscriptionStatus)

    The current status of the subscription contract.

  * shipping​Options

    [Subscription​Shipping​Option​Result](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/SubscriptionShippingOptionResult)

    Deprecated

***

## Examples

* ### subscriptionDraft reference

## Query Reference

```graphql
{
  subscriptionDraft(id) {
    # subscriptionDraft fields
  }
}
```