HubSpot: Validate price book

← Price books operations · Get started

Operation hubspot.price_books_validate_price_book

Provider route: POST /commerce/price-books/2026-09/price-books/{priceBookId}/validate. 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"]["validatePriceBook"]>[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.validatePriceBook(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.validate_price_book(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

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
$	Model	Root	Expand Validate price book — response body

Referenced models: Validate price book — response body

Schemas

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.

Policy, approvals and errors

SDK function policy ID: hubspot.price_books_validate_price_book. Catalog operation: price_books_validate_price_book. 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.read"]

Official provider source