Interface: LineItem
Properties
external_product_id
external_product_id:
ExternalId
An object containing the associated product ID as it appears in the external system.
external_variant_id
external_variant_id:
ExternalId
An object containing the associated variant ID as it appears in the external system.
grams
grams:
number
The weight of the item in grams.
handle
handle:
string
A unique, human-friendly string for the Product.
images
images:
ProductImage
An object containing URLs of the Product image.
offer_attributes?
optionaloffer_attributes:OfferAttributes
An object containing information on the related offer, if applicable
properties
properties:
Property[]
An array of name value pairs of additional line_item attributes.
purchase_item_id
purchase_item_id:
number
The Subscription or Onetime ID associated with the line_item.
purchase_item_type
purchase_item_type:
PlanType
An indicator of the type of the purchase item.
quantity
quantity:
number
The quantity of the line_item.
sku
sku:
string
The SKU (stock keeping unit) of the Product associated with the line_item.
tax_due
tax_due:
string
The total tax due associated with the line_item.
tax_lines
tax_lines:
TaxLine[]
an array containing tax_line objects associated with this line_item.
taxable
taxable:
boolean
A boolean indicating if the line_item is taxable or non-taxable.
taxable_amount
taxable_amount:
string
The taxable revenue associated with the line_item.
title
title:
string
The title of the Product of this line_item.
total_price
total_price:
string
The total price of the line_item including tax.
unit_price
unit_price:
string
The unit price of the line_item.
unit_price_includes_tax
unit_price_includes_tax:
boolean
A boolean indicator if tax is included in the price of an item.
variant_title
variant_title:
string
The name of a variant of the Product of this line_item.