Subscription
Requires access scope.
Represents a Subscription Draft error.
Anchor to FieldsFields
- Anchor to codecode•Subscription
Draft Error Code 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.
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 subscriptionBillingCycleContractDraftConcatenatesubscription•mutation
Billing Cycle Contract Draft Concatenate Concatenates a contract to a Subscription Draft.
- Anchor to draftIddraft•ID!
Id required The gid of the Subscription Contract draft to update.
- Anchor to concatenatedBillingCycleContractsconcatenated•[Subscription
Billing Cycle Contracts Billing Cycle Input!]! required An array of Subscription Contracts with their selected billing cycles to concatenate to the subscription draft.
Arguments
- •mutation
Edit the contents of a subscription contract for the specified billing cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object for selecting and using billing cycles.
Arguments
- •mutation
Creates a Subscription Contract.
- Anchor to inputinput•Subscription
Contract Atomic Create Input! required The properties of the new Subscription Contract.
Arguments
- •mutation
Creates a subscription contract draft, which is an intention to create a new subscription. The draft lets you incrementally build and modify subscription details before committing them to create the actual
.The mutation requires
Customerinformation, billing details, and contract configuration including theand. You can specify the, thefor shipping, and subscription intervals.After you create the draft, you can either modify it with the
mutation or finalize and create the active subscription contract with.Learn more about building subscription contracts.
- Anchor to inputinput•Subscription
Contract Create Input! required The properties of the new Subscription Contract.
Arguments
- •mutation
Allows for the easy change of a Product in a Contract or a Product price change.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
- Anchor to lineIdline•ID!
Id required The gid of the Subscription Line to update.
- Anchor to inputinput•Subscription
Contract Product Change Input! required The properties of the Product changes.
Arguments
- •mutation
Creates a draft of an existing
. The draft captures the current state of the contract and allows incremental modifications through draft mutations such as,, and.Changes remain in draft state and don't affect the live contract until committed. After you've made all necessary changes to the draft, commit it using
to apply the updates to the original contract.Learn more about updating subscription contracts.
- Anchor to contractIdcontract•ID!
Id required The gid of the Subscription Contract to update.
Arguments
- •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
- •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
- •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•String!
Code required Code discount redeem code.
Arguments
- •mutation
Removes a subscription discount from a subscription draft.
- Anchor to draftIddraft•ID!
Id required The gid of the subscription contract draft to remove a subscription discount from.
- Anchor to discountIddiscount•ID!
Id required The gid of the subscription draft discount to remove.
Arguments
- •mutation
Updates a subscription discount on a subscription draft.
- Anchor to draftIddraft•ID!
Id required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to discountIddiscount•ID!
Id required The gid of the Subscription Discount to update.
- Anchor to inputinput•Subscription
Manual Discount Input! required The properties to update on the Subscription Discount.
Arguments
- •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•Subscription
Free Shipping Discount Input! required The properties of the new subscription free shipping discount.
Arguments
- •mutation
Updates a subscription free shipping discount on a subscription draft.
- Anchor to draftIddraft•ID!
Id required The ID of the Subscription Contract draft to update a subscription discount on.
- Anchor to discountIddiscount•ID!
Id required The gid of the Subscription Discount to update.
- Anchor to inputinput•Subscription
Free Shipping Discount Input! required The properties to update on the Subscription Free Shipping Discount.
Arguments
- •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
- •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
- •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 lineIdline•ID!
Id required The gid of the Subscription Line to update.
- Anchor to inputinput•Subscription
Line Update Input! required The properties of the new Subscription Line.
Arguments
- •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