Choose a version:

SubscriptionDraftUserError

object

Requires read_own_subscription_contracts access scope.

Represents a Subscription Draft error.

Anchor to FieldsFields

Anchor to codecode •SubscriptionDraftErrorCode: The error code.
Anchor to fieldfield •[String!]: The path to the input field that caused the error.
Anchor to messagemessage •String!non-null: The error message.

Was this section helpful?

Anchor to MutationsMutations

subscriptionBillingCycleContractDraftCommit

•mutation

Commits the updates of a Subscription Billing Cycle Contract draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to commit.

Anchor to contractcontract •SubscriptionBillingCycleEditedContract: The committed Subscription Billing Cycle Edited Contract object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

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.

subscriptionContractAtomicCreate

•mutation

Creates a Subscription Contract.

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

Anchor to contractcontract •SubscriptionContract: The new 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.

subscriptionContractProductChange

•mutation

Allows for the easy change of a Product in a Contract or a Product price change.

Anchor to inputinput •SubscriptionContractProductChangeInput!required: The properties of the Product changes.
Anchor to lineIdlineId •ID!required: The gid of the Subscription Line to update.
Anchor to subscriptionContractIdsubscriptionContractId •ID!required: The ID of the subscription contract.

Anchor to contractcontract •SubscriptionContract: The new Subscription Contract 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.

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.

subscriptionDraftCommit

•mutation

Commits the updates of a Subscription Contract draft.

Anchor to draftIddraftId •ID!required: The gid of the Subscription Contract draft to commit.

Anchor to contractcontract •SubscriptionContract: The updated 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 DisplayableError DisplayableError •interface

Was this section helpful?

SubscriptionDraftUserError

Anchor to FieldsFields

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

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Anchor to InterfacesInterfaces