Update a price book item
Update a specific item within a price book in your HubSpot account. This operation allows you to modify details such as pricing, billing frequency, and custom properties for the specified item. Ensure that the item is identified correctly by its unique priceBookId and priceBookItemId.
Supported products
Supported products
Required Scopes
Required Scopes
Path Parameters
The unique identifier of the price book containing the item to update.
The unique identifier of the item within the price book to update.
Query Parameters
Whether to return only results that have been archived.
Body
An object specifying the frequency at which billing occurs for the price book item.
An object specifying the period over which billing occurs for the price book item.
A map of custom property names to their values, allowing for additional customization of the price book item.
An object indicating the current status of the price book item.
A boolean indicating whether the price book item is archived.
Response
successful operation
A map of custom property names to their values for the price book item.
The unique identifier for the price book item.
The unique identifier for the product associated with the price book item.
A boolean indicating whether the price book item is archived.
The date and time when the price book item was archived, in ISO 8601 format.
The frequency at which billing occurs for the price book item. Valid values include 'annually', 'biweekly', 'monthly', 'one_time', 'per_five_years', 'per_four_years', 'per_six_months', 'per_three_years', 'per_two_years', 'quarterly', and 'weekly'.
ANNUALLY, BIWEEKLY, MONTHLY, PER_FIVE_YEARS, PER_FOUR_YEARS, PER_SIX_MONTHS, PER_THREE_YEARS, PER_TWO_YEARS, QUARTERLY, WEEKLY The billing period for the price book item.
The cost of goods sold for the price book item.
The date and time when the price book item was created, in ISO 8601 format.
A description of the price book item.
A string representing images associated with the price book item.
The name of the price book item.
The unique identifier for the price book containing this item.
The classification of the product. Valid values include 'BUNDLE', 'STANDALONE', and 'VARIANT'.
BUNDLE, STANDALONE, VARIANT The type of product. Valid values include 'INVENTORY', 'NON_INVENTORY', and 'SERVICE'.
INVENTORY, NON_INVENTORY, SERVICE The terms of recurring billing for the price book item. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'.
AUTOMATICALLY_RENEW, FIXED The stock keeping unit (SKU) of the price book item.
The current status of the price book item. Valid values include 'active' and 'inactive'.
active, inactive The tax category of the price book item.
The date and time when the price book item was last updated, in ISO 8601 format.
A URL associated with the price book item.