Subscription
Requires access scope.
Represents a Subscription Draft.
Anchor to Fields and connectionsFields and connections
- Anchor to billingCyclebilling•
Cycle The billing cycle that the subscription contract will be associated with.
- Anchor to billingPolicybilling•
Policy SubscriptionBilling Policy!non-null The billing policy for the subscription contract.
- Anchor to concatenatedBillingCyclesconcatenated•
Billing Cycles The billing cycles of the contracts that will be concatenated to the subscription contract.
- Anchor to currencyCodecurrency•
Code CurrencyCode!non-null The currency used for the subscription contract.
- Anchor to customAttributescustom•
Attributes [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 customerPaymentMethodcustomer•
Payment Method The customer payment method used for the subscription contract.
- Anchor to deliveryMethoddelivery•
Method The delivery method for each billing of the subscription contract.
- Anchor to deliveryOptionsdelivery•
Options The available delivery options for a given delivery address. Returns
nullfor pending requests.- Anchor to deliveryPolicydelivery•
Policy SubscriptionDelivery Policy!non-null The delivery policy for the subscription contract.
- Anchor to deliveryPricedelivery•
Price The delivery price for each billing the subscription contract.
- Anchor to discountsdiscounts•Subscription
Discount Connection!non-null The list of subscription discounts which will be associated with the subscription contract.
- Anchor to discountsAddeddiscounts•
Added SubscriptionDiscount Connection!non-null The list of subscription discounts to be added to the subscription contract.
- Anchor to discountsRemoveddiscounts•
Removed SubscriptionDiscount Connection!non-null The list of subscription discounts to be removed from the subscription contract.
- Anchor to discountsUpdateddiscounts•
Updated SubscriptionDiscount Connection!non-null The list of subscription discounts to be updated on the subscription contract.
- •ID!non-null
A globally-unique ID.
- Anchor to lineslines•Subscription
Line Connection!non-null The list of subscription lines which will be associated with the subscription contract.
- Anchor to linesAddedlines•
Added SubscriptionLine Connection!non-null The list of subscription lines to be added to the subscription contract.
- Anchor to linesRemovedlines•
Removed SubscriptionLine Connection!non-null The list of subscription lines to be removed from the subscription contract.
- Anchor to nextBillingDatenext•
Billing Date The next billing date for the subscription contract.
- Anchor to notenote•
The note field that will be applied to the generated orders.
- Anchor to originalContractoriginal•
Contract The original subscription contract.
- Anchor to statusstatus•
The current status of the subscription contract.
- Anchor to shippingOptionsshipping•
Options Available Shipping Options for a given delivery address. Returns NULL for pending requests.
Anchor to QueriesQueries
- •query
Returns a Subscription Draft resource by ID.
Anchor to MutationsMutations
- 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 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
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
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