Skip to main content
object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents a Subscription Line.

Anchor to concatenatedOriginContractconcatenatedOriginContract
•SubscriptionContract

The origin contract of the line if it was concatenated from another contract.

•MoneyV2!non-null

The price per unit for the subscription line in the contract's currency.

•[Attribute!]!non-null

List of custom attributes associated to the line item.

•[SubscriptionDiscountAllocation!]!non-null

Discount allocations.

•ID!non-null

The unique ID.

•MoneyV2!non-null

Total line price including all discounts.

•SubscriptionPricingPolicy

Describe the price changes of the line over time.

•ID

The product ID associated with the subscription line.

•Int!non-null

The quantity of the unit selected for the subscription line.

•Boolean!non-null

Whether physical shipping is required for the variant.

•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.

•String

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.

•String

Variant SKU number of the item associated with the subscription line.

•Boolean!non-null

Whether the variant is taxable.

•String!non-null

Product title of the item associated with the subscription line.

•ID

The product variant ID associated with the subscription line.

•Image

The image associated with the line item's variant or product.

•String

Product variant title of the item associated with the subscription line.


Was this section helpful?

•mutation

Allows for the easy change of a Product in a Contract or a Product price change.

Arguments

•SubscriptionContractProductChangeInput!required

The properties of the Product changes.

•ID!required

The gid of the Subscription Line to update.

Anchor to subscriptionContractIdsubscriptionContractId
•ID!required

The ID of the subscription contract.


Fields

•SubscriptionContract

The new Subscription Contract object.

•SubscriptionLine

The updated Subscription Line.

•[SubscriptionDraftUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Adds a subscription line to a subscription draft.

Arguments

•ID!required

The gid of the Subscription Contract draft to add a subscription line to.

•SubscriptionLineInput!required

The properties of the new Subscription Line.


Fields

•SubscriptionDraft

The Subscription Contract draft object.

•SubscriptionLine

The added Subscription Line.

•[SubscriptionDraftUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Removes a subscription line from a subscription draft.

Arguments

•ID!required

The gid of the Subscription Contract draft to remove a subscription line from.

•ID!required

The gid of the Subscription Line to remove.


Fields

•[SubscriptionManualDiscount!]

The list of updated subscription discounts impacted by the removed line.

•SubscriptionDraft

The Subscription Contract draft object.

•SubscriptionLine

The removed Subscription Line.

•[SubscriptionDraftUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Updates a subscription line on a subscription draft.

Arguments

•ID!required

The gid of the Subscription Contract draft to update a subscription line from.

•SubscriptionLineUpdateInput!required

The properties of the new Subscription Line.

•ID!required

The gid of the Subscription Line to update.


Fields

•SubscriptionDraft

The Subscription Contract draft object.

•SubscriptionLine

The updated Subscription Line.

•[SubscriptionDraftUserError!]!non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?