HubSpot: Price books schemas

← Price books operations · All schemas

Add price book items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
productId	string	Required within parent	The unique identifier of the product to be added to the price book. It is a string and is required.

Add price book items — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean indicating whether the price book item is archived.
archivedAt	string	Optional	The date and time when the price book item was archived, in ISO 8601 format. Format: date-time
billingFrequency	string	Optional	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'. Known values: ANNUALLY, BIWEEKLY, MONTHLY, PER_FIVE_YEARS, PER_FOUR_YEARS, PER_SIX_MONTHS, PER_THREE_YEARS, PER_TWO_YEARS, QUARTERLY, WEEKLY
billingPeriod	string	Optional	The billing period for the price book item.
costOfGoodsSold	string	Optional	The cost of goods sold for the price book item.
createdAt	string	Optional	The date and time when the price book item was created, in ISO 8601 format. Format: date-time
customProperties	object	Required within parent	A map of custom property names to their values for the price book item. Additional keys: see wildcard field
customProperties.*	string	Additional keys
description	string	Optional	A description of the price book item.
id	string	Required within parent	The unique identifier for the price book item.
images	string	Optional	A string representing images associated with the price book item.
name	string	Optional	The name of the price book item.
priceBookId	string	Optional	The unique identifier for the price book containing this item.
pricing	Model	Optional	Expand Add price book items — response body — pricing
productClassification	string	Optional	The classification of the product. Valid values include 'BUNDLE', 'STANDALONE', and 'VARIANT'. Known values: BUNDLE, STANDALONE, VARIANT
productId	string	Required within parent	The unique identifier for the product associated with the price book item.
productType	string	Optional	The type of product. Valid values include 'INVENTORY', 'NON_INVENTORY', and 'SERVICE'. Known values: INVENTORY, NON_INVENTORY, SERVICE
recurringBillingTerms	string	Optional	The terms of recurring billing for the price book item. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'. Known values: AUTOMATICALLY_RENEW, FIXED
sku	string	Optional	The stock keeping unit (SKU) of the price book item.
status	string	Optional	The current status of the price book item. Valid values include 'active' and 'inactive'. Known values: active, inactive
taxCategory	string	Optional	The tax category of the price book item.
updatedAt	string	Optional	The date and time when the price book item was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A URL associated with the price book item.

Referenced models: Add price book items — response body — pricing

Add price book items — response body — pricing

Field	Type	Presence	Description and constraints
$	object	Root
prices	array	Required within parent	An array of price entries, each detailing the amount and currency for a specific pricing tier.
prices[]	Model	Each item	Expand Add price book items — response body — pricing prices item
pricingModel	string	Required within parent	The type of pricing model applied, which can be one of the following: 'FLAT', 'GRADUATED', 'STAIRSTEP', or 'VOLUME'. Known values: FLAT, GRADUATED, STAIRSTEP, VOLUME

Referenced models: Add price book items — response body — pricing prices item

Add price book items — response body — pricing prices item

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	A string representing the currency in which the price is denominated.
maxQuantity	JSON	Optional
maxQuantity (anyOf 1)	integer	Alternative	A string specifying the maximum quantity for which this pricing entry is applicable. Format: int32
maxQuantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price	JSON	Required within parent
price (anyOf 1)	number	Alternative	A number indicating the price of the product or service.
price (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Batch archive price book items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing a unique identifier for a public object. This property is required and is used to specify the objects involved in the batch operation.
inputs[]	Model	Each item	Expand Batch archive price book items — request body — body inputs item

Referenced models: Batch archive price book items — request body — body inputs item

Batch archive price book items — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for this object, represented as a string.

Batch create price book items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PriceBookAddProductRequest objects, each representing a product to be added to the price book. This property is required.
inputs[]	Model	Each item	Expand Add price book items — request body — body

Referenced models: Add price book items — request body — body

Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string specifying the category of the error.
context	object	Required within parent	An object containing additional context about the error, with each key mapping to an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Validate price book — response body — errors item
id	string	Optional	A string representing the unique identifier of the error.
links	object	Required within parent	An object mapping link names to URIs that provide documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message that describes the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Validate price book — response body — errors item

Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Price Book Item Response

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of PriceBookItemResponse objects representing the individual results of the batch operation.
results[]	Model	Each item	Expand Add price book items — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Add price book items — response body

Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Price Book Item Response With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each represented as a StandardError object.
errors[]	Model	Each item	Expand Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each represented as a PriceBookItemResponse object.
results[]	Model	Each item	Expand Add price book items — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Add price book items — response body, Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Batch update price book items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of objects, each representing a price book item to be updated. Each object must conform to the PriceBookItemBatchUpdateInput schema.
inputs[]	Model	Each item	Expand Batch update price book items — request body — body inputs item

Referenced models: Batch update price book items — request body — body inputs item

Batch update price book items — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the price book item to be updated. It is a string.
properties	Model	Required within parent	Expand Update price book item — request body — body

Referenced models: Update price book item — request body — body

Create price book — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	object	Required within parent	An object containing custom properties for the price book. Each property is a key-value pair where the key is a string and the value is also a string. This is a required property. Additional keys: see wildcard field
customProperties.*	string	Additional keys
description	string	Optional	A description of the price book. This is an optional string property.
name	string	Required within parent	The name of the price book. It is a required string property.
supportedCurrencies	array	Required within parent	An array of strings representing the currencies supported by the price book. This is a required property.
supportedCurrencies[]	string	Each item

Create price book — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean indicating whether this price book is archived.
archivedAt	string	Optional	The date and time when this price book was archived. Format: date-time
autoAssignmentEnabled	boolean	Required within parent	Indicates whether auto-assignment is enabled for the price book. A boolean value.
countOfIncludedProducts	JSON	Required within parent
countOfIncludedProducts (anyOf 1)	integer	Alternative	The number of products included in this price book. Format: int32
countOfIncludedProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	The date and time when this price book was created. Format: date-time
customProperties	object	Required within parent	A map of custom property names to their values for this price book. Additional keys: see wildcard field
customProperties.*	string	Additional keys
description	string	Optional	A description of the price book.
id	string	Required within parent	The unique identifier for this price book.
name	string	Optional	The name of the price book.
status	string	Required within parent	The current status of the price book. Valid values include 'ACTIVE' and 'INACTIVE'. Known values: ACTIVE, INACTIVE
supportedCurrencies	array	Required within parent	An array of currency codes that this price book supports.
supportedCurrencies[]	string	Each item
updatedAt	string	Optional	The date and time when this price book was last updated. Format: date-time

List price book items — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve price books — response body — paging
results	array	Required within parent	An array of price book items, each represented by a PriceBookItemResponse object.
results[]	Model	Each item	Expand Add price book items — response body

Referenced models: Add price book items — response body, Retrieve price books — response body — paging

Retrieve price books — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve price books — response body — paging
results	array	Required within parent	An array of price book objects, each represented by the PriceBookResponse schema.
results[]	Model	Each item	Expand Create price book — response body

Referenced models: Create price book — response body, Retrieve price books — response body — paging

Retrieve price books — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Retrieve price books — response body — paging next

Referenced models: Retrieve price books — response body — paging next

Retrieve price books — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor for pagination to retrieve the next set of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Update price book item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean indicating whether the price book item is archived.
billingFrequency	object	Required within parent	An object specifying the frequency at which billing occurs for the price book item.
billingPeriod	object	Required within parent	An object specifying the period over which billing occurs for the price book item.
customProperties	object	Required within parent	A map of custom property names to their values, allowing for additional customization of the price book item. Additional keys: see wildcard field
customProperties.*	string	Additional keys
pricing	Model	Optional	Expand Update price book item — request body — body pricing
status	object	Required within parent	An object indicating the current status of the price book item.

Referenced models: Update price book item — request body — body pricing

Update price book item — request body — body pricing

Field	Type	Presence	Description and constraints
$	object	Root
prices	array	Required within parent	An array of PriceUpdateEntry objects, each representing the pricing details for a product, including the currency code and amount.
prices[]	Model	Each item	Expand Update price book item — request body — body pricing prices item

Referenced models: Update price book item — request body — body pricing prices item

Update price book item — request body — body pricing prices item

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The currency code for the price, represented as a string.
maxQuantity	integer	Optional	The maximum quantity applicable for this price, represented as a string. Format: int32
price	object	Required within parent	An object representing the price details for the entry. The specific structure of this object is not detailed in the specification.

Update price book — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	object	Required within parent	An object containing custom properties for the price book, where each key is a property name and the value is a string. Additional keys: see wildcard field
customProperties.*	string	Additional keys
description	object	Required within parent	An object representing the description of the price book to be updated.
name	object	Required within parent	An object representing the name of the price book to be updated.
supportedCurrencies	array	Optional	An array of strings representing the currencies supported by the price book.
supportedCurrencies[]	string	Each item

Validate price book — response body

Field	Type	Presence	Description and constraints
$	object	Root
errors	array	Required within parent	An array of ErrorDetail objects providing information about any errors encountered during validation.
errors[]	Model	Each item	Expand Validate price book — response body — errors item
isValid	boolean	Required within parent	A boolean indicating whether the price book is valid.

Referenced models: Validate price book — response body — errors item

Validate price book — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail.
context	object	Optional	Context about the error condition, which may include additional information such as missing scopes or invalid property names. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. This is a required property.
subCategory	string	Optional	A specific category that contains more specific detail about the error.