Home > @infiniteobjects/shopify-data-manager > AdminTypes > SubscriptionLine
Represents a Subscription Line.
Signature:
export interface SubscriptionLine
Property | Modifiers | Type | Description |
---|---|---|---|
currentPrice | MoneyV2 | The price per unit for the subscription line in the contract’s currency. | |
customAttributes | Array<Attribute> | List of custom attributes associated to the line item. | |
discountAllocations | Array<SubscriptionDiscountAllocation> | Discount allocations. | |
id | Scalars[‘ID’][‘output’] | The unique ID. | |
lineDiscountedPrice | MoneyV2 | Total line price including all discounts. | |
pricingPolicy? | Maybe<SubscriptionPricingPolicy> | (Optional) Describe the price changes of the line over time. | |
productId? | Maybe<Scalars[‘ID’][‘output’]> | (Optional) The product ID associated with the subscription line. | |
quantity | Scalars[‘Int’][‘output’] | The quantity of the unit selected for the subscription line. | |
requiresShipping | Scalars[‘Boolean’][‘output’] | Whether physical shipping is required for the variant. | |
sellingPlanId? | Maybe<Scalars[‘ID’][‘output’]> | <p>(Optional) The selling plan ID associated to the line.</p><p>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.</p><p>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.</p> | |
sellingPlanName? | Maybe<Scalars[‘String’][‘output’]> | <p>(Optional) 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.</p><p>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.</p> | |
sku? | Maybe<Scalars[‘String’][‘output’]> | (Optional) Variant SKU number of the item associated with the subscription line. | |
taxable | Scalars[‘Boolean’][‘output’] | Whether the variant is taxable. | |
title | Scalars[‘String’][‘output’] | Product title of the item associated with the subscription line. | |
variantId? | Maybe<Scalars[‘ID’][‘output’]> | (Optional) The product variant ID associated with the subscription line. | |
variantImage? | Maybe<Image> | (Optional) The image associated with the line item’s variant or product. | |
variantTitle? | Maybe<Scalars[‘String’][‘output’]> | (Optional) Product variant title of the item associated with the subscription line. |