Subscription
Requires access scope.
Represents a Subscription Draft error.
Anchor to FieldsFields
- code (SubscriptionDraftErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Subscription
Draft Error Code The error code.
Show enum values
- 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
- subscriptionBillingCycleContractDraftCommit (SubscriptionBillingCycleContractDraftCommitPayload)
- subscriptionBillingCycleContractDraftConcatenate (SubscriptionBillingCycleContractDraftConcatenatePayload)
- subscriptionBillingCycleContractEdit (SubscriptionBillingCycleContractEditPayload)
- subscriptionContractAtomicCreate (SubscriptionContractAtomicCreatePayload)
- subscriptionContractProductChange (SubscriptionContractProductChangePayload)
- •mutation
Commits the updates of a Subscription Billing Cycle Contract draft.
Show payload
- 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.
Show payload
- 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.
Show input fields
- Anchor to draftIddraft•ID!
Id required The gid of the Subscription Contract draft to update.
Arguments
- •mutation
Edit the contents of a subscription contract for the specified billing cycle.
Show payload
- Anchor to actoractor•Subscription
Actor The actor who initiated a subscription action.
Show enum values
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required Input object for selecting and using billing cycles.
Show input fields
Arguments
- •mutation
Creates a Subscription Contract.
Show payload
- Anchor to inputinput•Subscription
Contract Atomic Create Input! required The properties of the new Subscription Contract.
Show input fields
Arguments
- •mutation
Allows for the easy change of a Product in a Contract or a Product price change.
Show payload
- Anchor to actoractor•Subscription
Actor The actor who initiated a subscription action.
Show enum values
- Anchor to inputinput•Subscription
Contract Product Change Input! required The properties of the Product changes.
Show input fields
- Anchor to lineIdline•ID!
Id required The gid of the Subscription Line to update.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
Arguments
Deprecated mutations
- subscriptionContractCreate (SubscriptionContractCreatePayload): deprecated
- subscriptionContractUpdate (SubscriptionContractUpdatePayload): deprecated
- subscriptionDraftCommit (SubscriptionDraftCommitPayload): deprecated
- subscriptionDraftDiscountAdd (SubscriptionDraftDiscountAddPayload): deprecated
- subscriptionDraftDiscountCodeApply (SubscriptionDraftDiscountCodeApplyPayload): deprecated
- subscriptionDraftDiscountRemove (SubscriptionDraftDiscountRemovePayload): deprecated
- subscriptionDraftDiscountUpdate (SubscriptionDraftDiscountUpdatePayload): deprecated
- subscriptionDraftFreeShippingDiscountAdd (SubscriptionDraftFreeShippingDiscountAddPayload): deprecated
- subscriptionDraftFreeShippingDiscountUpdate (SubscriptionDraftFreeShippingDiscountUpdatePayload): deprecated
- subscriptionDraftLineAdd (SubscriptionDraftLineAddPayload): deprecated
- subscriptionDraftLineRemove (SubscriptionDraftLineRemovePayload): deprecated
- subscriptionDraftLineUpdate (SubscriptionDraftLineUpdatePayload): deprecated
- subscriptionDraftUpdate (SubscriptionDraftUpdatePayload): deprecated
- •mutationDeprecated
Show payload
- Anchor to inputinput•Subscription
Contract Create Input! required The properties of the new Subscription Contract.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to actoractor•Subscription
Actor The actor who initiated a subscription action.
Show enum values
- Anchor to contractIdcontract•ID!
Id required The gid of the Subscription Contract to update.
Arguments
- •mutationDeprecated
Show payload
- Anchor to draftIddraft•ID!
Id required The gid of the Subscription Contract draft to commit.
Arguments
- •mutationDeprecated
Show payload
- 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.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- 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
- •mutationDeprecated
Show payload
- 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
- •mutationDeprecated
Show payload
- 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.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- 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.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- 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
Free Shipping Discount Input! required The properties to update on the Subscription Free Shipping Discount.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- 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.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- 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
- •mutationDeprecated
Show payload
- 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.
Show input fields
- Anchor to lineIdline•ID!
Id required The gid of the Subscription Line to update.
Arguments
- •mutationDeprecated
Show payload
- 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.
Show input fields
Arguments