Convert to Contract Price Book
POST https://api.secure.quotivity.com/v1/pricebooks/{priceBookId}/convertTurns a regular price book into a contract price book of parentPriceBookId. Entries equal to the parent’s are removed so they inherit; currencies the parent adjusts and this book left at the HubSpot price are kept at 100%, so no price of a product already on the book changes. Products in the parent that the book did not have are excluded, so the book keeps offering exactly what it did; restore any that should be offered. Up to 500 rewritten entries run in the request; larger books finish in the background and carry pendingParentPriceBookId until done (queued: true). Requires the CONTRACT_PRICE_BOOKS feature.
Send your API key in the x-api-key header. See Generating API keys.
Path parameters
Section titled “Path parameters”| Name | Type | Required | Description |
|---|---|---|---|
priceBookId |
string | Yes | — |
Request body
Section titled “Request body”Required, application/json: object
Responses
Section titled “Responses”| Status | Body | Description |
|---|---|---|
200 |
PriceBook & object | Price book converted (or conversion queued) |
400 |
— | Invalid parent price book, or the CONTRACT_PRICE_BOOKS feature is not enabled |
401 |
— | Unauthorized |
404 |
— | Price book not found |
406 |
— | Not acceptable: bundle option price book, a price book that has contract price books (PRICE_BOOK_HAS_CONTRACT_BOOKS), or a HubSpot sync error |
409 |
— | Already a contract price book (PRICE_BOOK_CONVERSION_PENDING) |
500 |
— | Internal Server Error |
Schemas
Section titled “Schemas”PriceBook
Section titled “PriceBook”| Field | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | — |
accountId |
string | Yes | — |
name |
string | Yes | — |
description |
string | Yes | — |
bundleOptionId |
string | No | — |
isDeleted |
boolean | No | — |
effectiveStartDate |
string | No | ISO date string (e.g. “2025-01-01”). Requires PRICE_BOOK_EFFECTIVE_DATES feature. |
effectiveEndDate |
string | No | ISO date string (e.g. “2025-12-31”). Requires PRICE_BOOK_EFFECTIVE_DATES feature. |
parentPriceBookId |
string | No | Set on a contract price book: the regular price book it inherits prices from. A contract price book stores only its differences (overrides, exclusions, added products) and is labelled “Contract: {name}” on HubSpot price book properties. Requires the CONTRACT_PRICE_BOOKS feature. |
pendingParentPriceBookId |
string | No | Set while a large conversion to a contract price book is still rewriting entries in the background. Cleared when it finishes. |
Ask the help center
Answers come from these guides, with links to the articles used.
Ask anything about configuring quoting in Quotivity Studio.