Lineitems
Lists all line items in HubSpot, with support for both OAuth and private-app token authentications.
Table Specific Information
In HubSpot, line items can be thought of as a subset of products. When a product is attached to a deal, it becomes a line item. You can create line items that are unique to an individual quote, but they will not be added to your product library.
SELECT
When selecting line items, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN
Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:
SELECT * FROM LineItems SELECT * FROM LineItems WHERE [Amount] > 1000 AND [Quantity] >= 10 SELECT * FROM LineItems WHERE [Product price] = 40 OR [Product description] = 'White t-shirt'
In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:
SELECT * FROM LineItems WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM LineItems WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM LineItems WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM LineItems WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})
INSERT
INSERT INTO LineItems (Description, [Product ID]) VALUES ('description', '33318601')
UPDATE
UPDATE LineItems SET Description = 'new description' WHERE ID = '168209183'
DELETE
DELETE FROM Deals WHERE ID = '168209183'
Columns
| Name | Type | ReadOnly | References | Filterable | Description |
| Id [KEY] | Long | True | True |
Unique identifier assigned to the line item object in HubSpot. | |
| Archived | Bool | True | False |
Indicates whether the line item has been archived and is no longer active. | |
| CreatedAt | Datetime | True | False |
Timestamp marking when the line item was first created. | |
| UpdatedAt | Datetime | True | False |
Timestamp marking when the line item was last updated. | |
| Net price | Decimal | True | True |
Final price of the line item after any discounts are applied. | |
| Create Date | Datetime | False | True |
Date when the line item record was created. | |
| Description | String | False | True |
Detailed description of the product associated with the line item. | |
| Unit discount | Decimal | False | True |
Discount amount applied to each unit of the product. | |
| Annual contract value | Decimal | True | True |
Annual contract value (ACV) generated by the product in the line item. | |
| All accessible team IDs | String | True | True |
List of all accessible team IDs, including hierarchical teams, associated with this line item. | |
| Business units | String | False | True |
Business units assigned to this line item for organizational reporting. | |
| All owner ids | String | True | True |
List of all owner user IDs assigned to this line item, both default and custom. | |
| All team ids | String | True | True |
List of all team IDs associated with this line item ownership. | |
| Allow buyer selected quantity | String | True | True |
Indicates whether buyers are allowed to select the quantity for this line item during checkout. | |
| Annual recurring revenue | Decimal | True | True |
Annual recurring revenue (ARR) associated with the product in this line item. | |
| Delayed billing start by days | Decimal | False | True |
Number of days by which billing for this line item should be delayed. | |
| Delayed billing start by months | Decimal | False | True |
Number of months by which billing for this line item should be delayed. | |
| Start billing terms | String | True | True |
Method used to define billing start date, such as a fixed date or a relative delay in days or months. | |
| Unit cost | Decimal | False | True |
Cost incurred by the seller for each unit of the product sold in the line item. | |
| Created by user ID | Decimal | True | True |
HubSpot user ID of the individual who created the line item. This value is set automatically. | |
| Object create date_time | Datetime | True | True |
Timestamp indicating when the line item object was created. This value is automatically set by HubSpot. | |
| Discount Percentage | Decimal | False | True |
Percentage discount applied to the unit price of the line item. | |
| External LineItem id | Decimal | True | True |
External ID referencing the line item from an outside system if applicable. | |
| Image URL | String | False | True |
URL link to the product image associated with the line item. | |
| Last Modified Date | Datetime | True | True |
Timestamp when any property of the line item was last modified. | |
| Currency | String | False | True |
Currency code in which the line item amount is recorded, such as USD or EUR. | |
| Margin | Decimal | True | True |
Profit margin value for the product included in the line item. | |
| Annual contract value margin | Decimal | True | True |
Profit margin calculated on the annual contract value (ACV) of the line item. | |
| Annual recurring revenue margin | Decimal | True | True |
Profit margin calculated on the annual recurring revenue (ARR) of the line item. | |
| Monthly recurring revenue margin | Decimal | True | True |
Profit margin calculated on the monthly recurring revenue (MRR) of the line item. | |
| Total contract value margin | Decimal | True | True |
Profit margin calculated on the total contract value (TCV) of the line item. | |
| Merged object IDs | String | True | True |
List of merged line item object IDs. This value is automatically set by HubSpot. | |
| Monthly recurring revenue | Decimal | True | True |
Monthly recurring revenue (MRR) generated by the product in the line item. | |
| Record ID | Decimal | True | True |
Unique HubSpot-generated ID for the line item record. | |
| Position on quote | Decimal | False | True |
Order or position number of the line item as it appears on quotes. | |
| Pre Discount Amount | Decimal | True | True |
Total amount of the line item before any discounts are applied. | |
| Product ID | Decimal | False | True |
Identifier of the product this line item is based on, typically from the product catalog. | |
| Read Only Object | Bool | True | True |
Indicates whether the line item is read-only and cannot be modified. | |
| End Date | Date | True | True |
Date when recurring billing ends for this line item. | |
| Number of payments | Decimal | True | True |
Total number of scheduled payments for this line item. | |
| Term | String | False | True |
Duration of recurring billing for the product associated with the line item. | |
| Billing start date | Date | False | True |
Date when recurring billing begins for the line item. | |
| Billing terms | String | True | True |
Billing structure, such as fixed payment count or continuous until canceled. | |
| SKU | String | False | True |
Stock Keeping Unit — a unique identifier used to track the product in inventory or commerce systems. | |
| Sync amount | Decimal | True | True |
Amount value pulled in from ecommerce platform sync integrations. | |
| Total contract value | Decimal | True | True |
Total contract value (TCV) of the product included in the line item. | |
| Term in months | Decimal | True | True |
Length of the contract or recurring billing term expressed in months. | |
| Calculated Total Discount | Decimal | True | True |
Total discount value for the line item, accounting for both flat amount and percentage discounts. | |
| Unique creation key | String | True | True |
Unique key used to prevent duplication during idempotent creation of the line item. | |
| Updated by user ID | Decimal | True | True |
User ID of the individual who last updated this line item. Automatically managed by HubSpot. | |
| URL | String | False | True |
URL pointing to the product page associated with this line item. | |
| User IDs of all notification followers | String | True | True |
List of user IDs who have opted in to receive notifications for this line item. | |
| User IDs of all notification unfollowers | String | True | True |
List of owner user IDs who opted out of receiving follow notifications for this line item. | |
| User IDs of all owners | String | True | True |
List of all user IDs assigned as owners of this line item. | |
| Variant id of the product | Decimal | True | True |
ID of the specific product variant associated with this line item, often from platforms like Shopify. | |
| Owner Assigned Date | Datetime | True | True |
Date and time when an owner was assigned to the line item. Useful for reporting and segmentation. | |
| Owner | String | False | True |
User currently assigned as the owner of the line item. | |
| HubSpot Team | String | True | True |
Primary HubSpot team associated with the owner of the line item. | |
| Name | String | False | True |
Name of the product linked to the line item. | |
| Unit price | Decimal | False | True |
Unit price of the product before any discounts are applied. | |
| Quantity | Decimal | False | True |
Number of units of the product included in this line item. | |
| Billing frequency | String | False | True |
How often the line item is billed for recurring billing (such as monthly, annually, or one-time). | |
| Tax | Decimal | False | True |
Amount of tax applied to the line item. |