API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

SubscriptionLine object

Version 2021-01 (Release candidate)

Represents a Subscription Line.

Required access

Requires access to either all or app-owned subscription contracts.

Fields

currentPrice (MoneyV2!)

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

customAttributes ([Attribute!]!)

List of custom attributes associated to the line item.

discountAllocations ([SubscriptionDiscountAllocation!]!)

Discount allocations.

id (ID!)

The unique identifier.

lineDiscountedPrice (MoneyV2!)

Total line price including all discounts.

pricingPolicy (SubscriptionPricingPolicy)

Describe the price changes of the line over time.

productId (ID)

The product id associated with the subscription line.

quantity (Int!)

The quantity of the unit selected for the subscription line.

requiresShipping (Boolean!)

Whether physical shipping is required for the variant.

sellingPlanId (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.

sellingPlanName (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.

sku (String)

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

taxable (Boolean!)

Whether the variant is taxable.

title (String!)

Product title of the item associated with the subscription line.

variantId (ID)

The product variant id associated with the subscription line.

variantImage (Image)

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

variantTitle (String)

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

Types that return SubscriptionLine