Line Items
In HubSpot, line items are individual instances 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. The line items endpoints allow you to manage this data and sync it between HubSpot and other systems.
Example use case: when creating a set of quotes for sales reps to send to potential buyers, you can use this API to create standalone line items per quote, as well as line items that are attached to existing products.
To create a line item, make a POST
request to /crm/v3/objects/line_items
. In the post body, include the line item's details, such as name, quantity, and price. To create a line item based on an existing product (created through the products API or in HubSpot), include hs_product_id
in the post body.
You can also associate the line item with deals and quotes by including an associations
array in the post body. For example, the post body below would create a line item named "New standalone line item" that's associated with a deal (ID: 12345
) and a quote (ID: 67890
).
Please note: the line items Term property (hs_recurring_billing_period
) accepts ISO-8601 period formats of PnYnMnD and PnW.
You can retrieve line items individually or in bulk.
- To retrieve a specific line item, make a
GET
request to/crm/v3/objects/line_items/{lineItemId}
wherelineItemId
is the ID of the line item. - To retrieve all line items, make a
GET
request to/crm/v3/objects/line_items
.
Parameter | Description |
---|---|
properties
| A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. |
propertiesWithHistory
| A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. |
To update a line item, make a PATCH
request to /crm/v3/objects/line_items/{lineItemId}
, where lineItemId
is the ID of the line item.
In the post body, include the property values that you want to update. You cannot update associations through this method. Instead you'll need to use the associations API.
For example, your request body might look similar to the following:
Thank you for your feedback, it means a lot to us.