Subscription
Requires access scope.
Represents a Subscription Draft error.
Anchor to FieldsFields
- Anchor to codecode•
The error code.
- Anchor to fieldfield•
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Commits the updates of a Subscription Billing Cycle Contract draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to commit.
Arguments
- Anchor to contractcontract•
The committed Subscription Billing Cycle Edited Contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- Anchor to subscriptionBillingCycleContractDraftConcatenatesubscription•
Billing Cycle Contract Draft Concatenate mutation Concatenates a contract to a Subscription Draft.
- Anchor to concatenatedBillingCycleContractsconcatenated•
Billing Cycle Contracts An array of Subscription Contracts with their selected billing cycles to concatenate to the subscription draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to update.
Arguments
- Anchor to draftdraft•
The Subscription Draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Edit the contents of a subscription contract for the specified billing cycle.
- Anchor to billingCycleInputbilling•
Cycle Input SubscriptionBilling Cycle Input!required Input object for selecting and using billing cycles.
Arguments
- Anchor to draftdraft•
The draft subscription contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a Subscription Contract.
- Anchor to inputinput•
The properties of the new Subscription Contract.
Arguments
- Anchor to contractcontract•
The new Subscription Contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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•Subscription
Contract Create Input!required The properties of the new Subscription Contract.
Arguments
- Anchor to draftdraft•
The Subscription Contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Allows for the easy change of a Product in a Contract or a Product price change.
- Anchor to inputinput•
The properties of the Product changes.
- Anchor to lineIdline•
Id ID!required The gid of the Subscription Line to update.
- Anchor to subscriptionContractIdsubscription•
Contract Id ID!required The ID of the subscription contract.
Arguments
- Anchor to contractcontract•
The new Subscription Contract object.
- Anchor to lineUpdatedline•
Updated The updated Subscription Line.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 contractIdcontract•
Id ID!required The gid of the Subscription Contract to update.
Arguments
- Anchor to draftdraft•
The Subscription Contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Commits the updates of a Subscription Contract draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to commit.
Arguments
- Anchor to contractcontract•
The updated Subscription Contract object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a subscription discount to a subscription draft.
- Anchor to draftIddraft•
Id ID!required The ID of the Subscription Contract draft to add a subscription discount to.
- Anchor to inputinput•Subscription
Manual Discount Input!required The properties of the new Subscription Discount.
Arguments
- Anchor to discountAddeddiscount•
Added The added Subscription Discount.
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Applies a code discount on the subscription draft.
- Anchor to draftIddraft•
Id ID!required The gid of the subscription contract draft to apply a subscription code discount on.
- Anchor to redeemCoderedeem•
Code String!required Code discount redeem code.
Arguments
- Anchor to appliedDiscountapplied•
Discount The added subscription discount.
- Anchor to draftdraft•
The subscription contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes a subscription discount from a subscription draft.
- Anchor to discountIddiscount•
Id ID!required The gid of the subscription draft discount to remove.
- Anchor to draftIddraft•
Id ID!required The gid of the subscription contract draft to remove a subscription discount from.
Arguments
- Anchor to discountRemoveddiscount•
Removed The removed subscription draft discount.
- Anchor to draftdraft•
The subscription contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a subscription discount on a subscription draft.
- Anchor to discountIddiscount•
Id ID!required The gid of the Subscription Discount to update.
- Anchor to draftIddraft•
Id ID!required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to inputinput•Subscription
Manual Discount Input!required The properties to update on the Subscription Discount.
Arguments
- Anchor to discountUpdateddiscount•
Updated The updated Subscription Discount.
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a subscription free shipping discount to a subscription draft.
- Anchor to draftIddraft•
Id ID!required The ID of the subscription contract draft to add a subscription free shipping discount to.
- Anchor to inputinput•
The properties of the new subscription free shipping discount.
Arguments
- Anchor to discountAddeddiscount•
Added The added subscription free shipping discount.
- Anchor to draftdraft•
The subscription contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a subscription free shipping discount on a subscription draft.
- Anchor to discountIddiscount•
Id ID!required The gid of the Subscription Discount to update.
- Anchor to draftIddraft•
Id ID!required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to inputinput•
The properties to update on the Subscription Free Shipping Discount.
Arguments
- Anchor to discountUpdateddiscount•
Updated The updated Subscription Discount.
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a subscription line to a subscription draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to add a subscription line to.
- Anchor to inputinput•Subscription
Line Input!required The properties of the new Subscription Line.
Arguments
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to lineAddedline•
Added The added Subscription Line.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes a subscription line from a subscription draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to remove a subscription line from.
- Anchor to lineIdline•
Id ID!required The gid of the Subscription Line to remove.
Arguments
- Anchor to discountsUpdateddiscounts•
Updated The list of updated subscription discounts impacted by the removed line.
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to lineRemovedline•
Removed The removed Subscription Line.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a subscription line on a subscription draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Contract draft to update a subscription line from.
- Anchor to inputinput•Subscription
Line Update Input!required The properties of the new Subscription Line.
- Anchor to lineIdline•
Id ID!required The gid of the Subscription Line to update.
Arguments
- Anchor to draftdraft•
The Subscription Contract draft object.
- Anchor to lineUpdatedline•
Updated The updated Subscription Line.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a Subscription Draft.
- Anchor to draftIddraft•
Id ID!required The gid of the Subscription Draft to update.
- Anchor to inputinput•Subscription
Draft Input!required The properties of the new Subscription Contract.
Arguments
- Anchor to draftdraft•
The Subscription Draft object.
- Anchor to userErrorsuser•
Errors [SubscriptionDraft User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields