Subscription
Requires the or scope.
Represents a Subscription Line.
Anchor to FieldsFields
- Anchor to currentPricecurrent•
Price MoneyV2!non-null The price per unit for the subscription line in the contract's currency.
- Anchor to customAttributescustom•
Attributes [Attribute!]!non-null List of custom attributes associated to the line item.
- Anchor to discountAllocationsdiscount•
Allocations Discount allocations.
- •ID!non-null
The unique ID.
- Anchor to lineDiscountedPriceline•
Discounted Price MoneyV2!non-null Total line price including all discounts.
- Anchor to pricingPolicypricing•
Policy Describe the price changes of the line over time.
- Anchor to productIdproduct•
Id The product ID associated with the subscription line.
- Anchor to quantityquantity•Int!non-null
The quantity of the unit selected for the subscription line.
- Anchor to requiresShippingrequires•
Shipping Boolean!non-null Whether physical shipping is required for the variant.
- Anchor to sellingPlanIdselling•
Plan Id The selling plan ID associated to the line.
Indicates which selling plan was used to create this contract line initially. The selling plan ID is also used to find the associated delivery profile.
The subscription contract, subscription line, or selling plan might have changed. As a result, the selling plan's attributes might not match the information on the contract.
- Anchor to sellingPlanNameselling•
Plan Name The selling plan name associated to the line. This name describes the order line items created from this subscription line for both merchants and customers.
The value can be different from the selling plan's name, because both the selling plan's name and the subscription line's selling_plan_name attribute can be updated independently.
- •
Variant SKU number of the item associated with the subscription line.
- Anchor to taxabletaxable•Boolean!non-null
Whether the variant is taxable.
- Anchor to titletitle•String!non-null
Product title of the item associated with the subscription line.
- Anchor to variantIdvariant•
Id The product variant ID associated with the subscription line.
- Anchor to variantImagevariant•
Image The image associated with the line item's variant or product.
- Anchor to variantTitlevariant•
Title Product variant title of the item associated with the subscription line.
Anchor to MutationsMutations
- •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
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