Skip to main content
Log inSign up
object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents a Subscription Line.

•
MoneyV2!non-null

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

•

List of custom attributes associated to the line item.

•

Discount allocations.

•
ID!non-null

The unique ID.

•
MoneyV2!non-null

Total line price including all discounts.

•

Describe the price changes of the line over time.

•

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.

•

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.

•

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.

•
Boolean!non-null

Whether the variant is taxable.

•
String!non-null

Product title of the item associated with the subscription line.

•

The product variant ID associated with the subscription line.

•

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

•

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.

•
mutation

Adds a subscription line to a subscription draft.

•
mutation

Removes a subscription line from a subscription draft.

•
mutation

Updates a subscription line on a subscription draft.


Was this section helpful?