SubscriptionDraft - admin-graphql - OBJECT

Version: 2024-10

Description:

Represents a Subscription Draft.

Access Scopes

`read_own_subscription_contracts` access scope.

Fields

  • billingCycle: SubscriptionBillingCycle - The billing cycle that the subscription contract will be associated with.
  • billingPolicy: SubscriptionBillingPolicy! - The billing policy for the subscription contract.
  • currencyCode: CurrencyCode! - The currency used for the subscription contract.
  • customAttributes: Attribute! - A list of the custom attributes to be added to the generated orders.
  • customer: Customer! - The customer to whom the subscription contract belongs.
  • customerPaymentMethod: CustomerPaymentMethod - The customer payment method used for the subscription contract.
  • deliveryMethod: SubscriptionDeliveryMethod - The delivery method for each billing of the subscription contract.
  • deliveryOptions: SubscriptionDeliveryOptionResult - The available delivery options for a given delivery address. Returns `null` for pending requests.
  • deliveryPolicy: SubscriptionDeliveryPolicy! - The delivery policy for the subscription contract.
  • deliveryPrice: MoneyV2 - The delivery price for each billing the subscription contract.
  • id: ID! - A globally-unique ID.
  • nextBillingDate: DateTime - The next billing date for the subscription contract.
  • note: String - The note field that will be applied to the generated orders.
  • originalContract: SubscriptionContract - The original subscription contract.
  • shippingOptions: SubscriptionShippingOptionResult - Available Shipping Options for a given delivery address. Returns NULL for pending requests.
  • status: SubscriptionContractSubscriptionStatus - The current status of the subscription contract.

Connections

  • concatenatedBillingCycles: SubscriptionBillingCycleConnection!
  • discounts: SubscriptionDiscountConnection!
  • discountsAdded: SubscriptionDiscountConnection!
  • discountsRemoved: SubscriptionDiscountConnection!
  • discountsUpdated: SubscriptionDiscountConnection!
  • lines: SubscriptionLineConnection!
  • linesAdded: SubscriptionLineConnection!
  • linesRemoved: SubscriptionLineConnection!

Related queries

  • subscriptionDraft Returns a Subscription Draft resource by ID.

Related mutations

  • subscriptionBillingCycleContractDraftConcatenate Concatenates a contract to a Subscription Draft.
  • subscriptionBillingCycleContractEdit Edit the contents of a subscription contract for the specified billing cycle.
  • subscriptionContractCreate Creates a Subscription Contract Draft. You can submit all the desired information for the draft using [Subscription Draft Input object](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/SubscriptionDraftInput). You can also update the draft using the [Subscription Contract Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionContractUpdate) mutation. The draft is not saved until you call the [Subscription Draft Commit](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftCommit) mutation.
  • subscriptionContractUpdate The subscriptionContractUpdate mutation allows you to create a draft of an existing subscription contract. This [draft](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionDraft) can be reviewed and modified as needed. Once the draft is committed with [subscriptionDraftCommit](https://shopify.dev/api/admin-graphql/latest/mutations/subscriptionDraftCommit), the changes are applied to the original subscription contract.
  • 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.

Related Unions

Examples