Choose a version:

SubscriptionDraft

object

Requires read_own_subscription_contracts access scope.

Represents a Subscription Draft.

Anchor to Fields and connectionsFields and connections

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.
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 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 discountsAddeddiscountsAdded •SubscriptionDiscountConnection!non-null: The list of subscription discounts to be added to the subscription contract.
Anchor to discountsRemoveddiscountsRemoved •SubscriptionDiscountConnection!non-null: The list of subscription discounts to be removed from the subscription contract.
Anchor to discountsUpdateddiscountsUpdated •SubscriptionDiscountConnection!non-null: The list of subscription discounts to be updated on the subscription contract.
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 linesAddedlinesAdded •SubscriptionLineConnection!non-null: The list of subscription lines to be added to the subscription contract.
Anchor to linesRemovedlinesRemoved •SubscriptionLineConnection!non-null: The list of subscription lines to be removed from the subscription contract.
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 •SubscriptionShippingOptionResultDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to subscriptionDraft subscriptionDraft •query: Returns a Subscription Draft resource by ID.

Was this section helpful?

Anchor to MutationsMutations

subscriptionBillingCycleContractDraftConcatenate

•mutation

Concatenates a contract to a Subscription Draft.

Anchor to concatenatedBillingCycleContractsconcatenatedBillingCycleContracts •[SubscriptionBillingCycleInput!]!required: An array of Subscription Contracts with their selected billing cycles to concatenate to the subscription draft.
Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to update.

Anchor to draftdraft •SubscriptionDraft: The Subscription Draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionBillingCycleContractEdit

•mutation

Edit the contents of a subscription contract for the specified billing cycle.

Anchor to billingCycleInputbillingCycleInput •SubscriptionBillingCycleInput!required: Input object for selecting and using billing cycles.

Anchor to draftdraft •SubscriptionDraft: The draft subscription contract object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionContractCreate

•mutation

Creates a Subscription Contract Draft. You can submit all the desired information for the draft using Subscription Draft Input object. You can also update the draft using the Subscription Contract Update mutation. The draft is not saved until you call the Subscription Draft Commit mutation.

Anchor to inputinput •SubscriptionContractCreateInput!required: The properties of the new Subscription Contract.

Anchor to draftdraft •SubscriptionDraft: The Subscription Contract object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionContractUpdate

•mutation

The subscriptionContractUpdate mutation allows you to create a draft of an existing subscription contract. This draft can be reviewed and modified as needed. Once the draft is committed with subscriptionDraftCommit, the changes are applied to the original subscription contract.

Anchor to contractIdcontractId •ID!required: The gid of the Subscription Contract to update.

Anchor to draftdraft •SubscriptionDraft: The Subscription Contract object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftDiscountAdd

•mutation

Adds a subscription discount to a subscription draft.

Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to add a subscription discount to.
Anchor to inputinput •SubscriptionManualDiscountInput!required: The properties of the new Subscription Discount.

Anchor to discountAddeddiscountAdded •SubscriptionManualDiscount: The added Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftDiscountCodeApply

•mutation

Applies a code discount on the subscription draft.

Anchor to draftIddraftId •ID!required: The gid of the subscription contract draft to apply a subscription code discount on.
Anchor to redeemCoderedeemCode •String!required: Code discount redeem code.

Anchor to appliedDiscountappliedDiscount •SubscriptionAppliedCodeDiscount: The added subscription discount.
Anchor to draftdraft •SubscriptionDraft: The subscription contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftDiscountRemove

•mutation

Removes a subscription discount from a subscription draft.

Anchor to discountIddiscountId •ID!required: The gid of the subscription draft discount to remove.
Anchor to draftIddraftId •ID!required: The gid of the subscription contract draft to remove a subscription discount from.

Anchor to discountRemoveddiscountRemoved •SubscriptionDiscount: The removed subscription draft discount.
Anchor to draftdraft •SubscriptionDraft: The subscription contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftDiscountUpdate

•mutation

Updates a subscription discount on a subscription draft.

Anchor to discountIddiscountId •ID!required: The gid of the Subscription Discount to update.
Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to inputinput •SubscriptionManualDiscountInput!required: The properties to update on the Subscription Discount.

Anchor to discountUpdateddiscountUpdated •SubscriptionManualDiscount: The updated Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftFreeShippingDiscountAdd

•mutation

Adds a subscription free shipping discount to a subscription draft.

Anchor to draftIddraftId •ID!required: The ID of the subscription contract draft to add a subscription free shipping discount to.
Anchor to inputinput •SubscriptionFreeShippingDiscountInput!required: The properties of the new subscription free shipping discount.

Anchor to discountAddeddiscountAdded •SubscriptionManualDiscount: The added subscription free shipping discount.
Anchor to draftdraft •SubscriptionDraft: The subscription contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftFreeShippingDiscountUpdate

•mutation

Updates a subscription free shipping discount on a subscription draft.

Anchor to discountIddiscountId •ID!required: The gid of the Subscription Discount to update.
Anchor to draftIddraftId •ID!required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to inputinput •SubscriptionFreeShippingDiscountInput!required: The properties to update on the Subscription Free Shipping Discount.

Anchor to discountUpdateddiscountUpdated •SubscriptionManualDiscount: The updated Subscription Discount.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftLineAdd

•mutation

Adds a subscription line to a subscription draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to add a subscription line to.
Anchor to inputinput •SubscriptionLineInput!required: The properties of the new Subscription Line.

Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to lineAddedlineAdded •SubscriptionLine: The added Subscription Line.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftLineRemove

•mutation

Removes a subscription line from a subscription draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to remove a subscription line from.
Anchor to lineIdlineId •ID!required: The gid of the Subscription Line to remove.

Anchor to discountsUpdateddiscountsUpdated •[SubscriptionManualDiscount!]: The list of updated subscription discounts impacted by the removed line.
Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to lineRemovedlineRemoved •SubscriptionLine: The removed Subscription Line.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftLineUpdate

•mutation

Updates a subscription line on a subscription draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to update a subscription line from.
Anchor to inputinput •SubscriptionLineUpdateInput!required: The properties of the new Subscription Line.
Anchor to lineIdlineId •ID!required: The gid of the Subscription Line to update.

Anchor to draftdraft •SubscriptionDraft: The Subscription Contract draft object.
Anchor to lineUpdatedlineUpdated •SubscriptionLine: The updated Subscription Line.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

subscriptionDraftUpdate

•mutation

Updates a Subscription Draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Draft to update.
Anchor to inputinput •SubscriptionDraftInput!required: The properties of the new Subscription Contract.

Anchor to draftdraft •SubscriptionDraft: The Subscription Draft object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?

SubscriptionDraft

Anchor to Fields and connectionsFields and connections

Anchor to QueriesQueries

Anchor to MutationsMutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Anchor to InterfacesInterfaces