HubSpot: Batch create price book items

← Price books operations · Get started

Operation hubspot.price_books_batch_create_price_book_items

Provider route: POST /commerce/price-books/2026-09/price-books/{priceBookId}/items/batch/create. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["priceBooks"]["batchCreatePriceBookItems"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.priceBooks.batchCreatePriceBookItems(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.price_books.batch_create_price_book_items(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.priceBookId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Batch create price book items — request body — body

Referenced models: Batch create price book items — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Price Book Item Response
$ (anyOf 2)	Model	Alternative	Expand Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Price Book Item Response With Errors

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

Schemas

2 more schemas are linked from the tables above, on the schema pages.

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 — 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

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

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

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

Policy, approvals and errors

SDK function policy ID: hubspot.price_books_batch_create_price_book_items. Catalog operation: price_books_batch_create_price_book_items. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["cpq.price_books.write"]

Official provider source