> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Preview Changes
> Preview the changes to a contract before they are applied. This endpoint allows you to simulate contract modifications and view the resulting changes to line items. It is useful for reviewing potential impacts of contract updates without committing them.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2027-03-beta/commerce-contracts-v2027-03-beta.json POST /commerce/contracts/2027-03-beta/changes/preview
openapi: 3.0.1
info:
title: Commerce Contracts
description: Basepom for all HubSpot Projects
version: 2027-03-beta
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Changes
paths:
/commerce/contracts/2027-03-beta/changes/preview:
post:
tags:
- Advanced
summary: Preview Changes
description: >-
Preview the changes to a contract before they are applied. This endpoint
allows you to simulate contract modifications and view the resulting
changes to line items. It is useful for reviewing potential impacts of
contract updates without committing them.
operationId: >-
post-/commerce/contracts/2027-03-beta/changes/preview_/commerce/contracts/2026-09-beta/changes/preview
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContractChangeCreateRequest'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ContractChangePreviewResponse'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- contracts-read
components:
schemas:
ContractChangeCreateRequest:
properties: {}
oneOf:
- $ref: '#/components/schemas/DirectContractChangeCreateRequest'
- $ref: '#/components/schemas/QuoteContractChangeCreateRequest'
ContractChangePreviewResponse:
required:
- deltaLineItems
- proposedLineItems
type: object
properties:
deltaLineItems:
type: array
items:
$ref: '#/components/schemas/LineItem'
proposedLineItems:
type: array
items:
$ref: '#/components/schemas/LineItem'
DirectContractChangeCreateRequest:
required:
- autoAccept
- lineItemChanges
- prorating
- type
type: object
properties:
autoAccept:
type: boolean
description: >-
A boolean indicating whether the contract change should be
automatically accepted.
contractId:
type: string
effectiveDate:
type: string
description: >-
The date when the contract change becomes effective, formatted as a
date string.
format: date
lineItemChanges:
type: array
description: >-
An array of line item changes to be applied to the contract. Each
item in the array is a reference to a LineItemChangeRequest.
items:
$ref: '#/components/schemas/LineItemChangeRequest'
name:
type: string
description: A string representing the name of the contract change.
prorating:
type: boolean
description: A boolean indicating whether the contract change should be prorated.
type:
type: string
description: >-
A string representing the type of contract change. The default and
only valid value is 'DIRECT'.
default: DIRECT
enum:
- DIRECT
x-hubspot-sub-type-impl: true
QuoteContractChangeCreateRequest:
required:
- prorating
- quoteTemplateId
- type
type: object
properties:
contractId:
type: string
dealId:
type: string
description: >-
A string representing the ID of the deal associated with the
contract change.
dealPipeline:
type: string
description: >-
A string representing the pipeline of the deal associated with the
contract change.
dealStage:
type: string
description: >-
A string representing the stage of the deal associated with the
contract change.
effectiveDate:
type: string
description: >-
A string representing the date when the contract change becomes
effective, in 'date' format.
format: date
name:
type: string
description: A string representing the name of the contract change.
prorating:
type: boolean
description: A boolean indicating whether the contract change should be prorated.
quoteTemplateId:
type: string
description: >-
A string that identifies the quote template associated with the
contract change.
type:
type: string
description: >-
A string that specifies the type of contract change. The default
value is 'QUOTE'.
default: QUOTE
enum:
- QUOTE
x-hubspot-sub-type-impl: true
LineItem:
required:
- id
- name
- pricing
- quantity
type: object
properties:
acv:
type: number
description: The annual contract value for the line item. A numeric value.
allowBuyerSelectedQuantity:
type: boolean
description: >-
Indicates whether the buyer can select the quantity of the line
item. A boolean value.
amount:
type: number
description: >-
The total amount for the line item, calculated as price multiplied
by quantity. A numeric value.
archived:
type: boolean
description: Indicates whether the line item is archived. A boolean value.
archivedAt:
type: string
description: >-
The date and time when the line item was archived, in ISO 8601
format.
format: date-time
arr:
type: number
description: The annual recurring revenue for the line item. A numeric value.
billingCycleAnchorDate:
type: string
description: The anchor date for the billing cycle, in ISO 8601 format.
format: date
billingPeriodEndDate:
type: string
description: The end date of the billing period, in ISO 8601 format.
format: date
billingPeriodStartDate:
type: string
description: The start date of the billing period, in ISO 8601 format.
format: date
billingStartDelayDays:
type: integer
description: >-
The number of days to delay the start of billing, represented as an
integer.
format: int32
billingStartDelayMonths:
type: integer
description: >-
The number of months to delay the start of billing, represented as
an integer.
format: int32
billingStartDelayType:
type: string
description: >-
The type of delay for the start of billing. Valid values include
'HS_BILLING_START_DELAY_DAYS', 'HS_BILLING_START_DELAY_MONTHS', and
'HS_RECURRING_BILLING_START_DATE'.
enum:
- HS_BILLING_START_DELAY_DAYS
- HS_BILLING_START_DELAY_MONTHS
- HS_RECURRING_BILLING_START_DATE
buyerSelectedQuantityMax:
type: number
description: >-
The maximum quantity that a buyer can select for the line item. A
numeric value.
buyerSelectedQuantityMin:
type: number
description: >-
The minimum quantity that a buyer can select for the line item. A
numeric value.
createdAt:
type: string
description: >-
The date and time when the line item was created, in ISO 8601
format.
format: date-time
description:
type: string
description: A text description of the line item.
discount:
type: number
description: The discount applied to the line item. A numeric value.
discountPercentage:
type: number
description: The percentage discount applied to the line item. A numeric value.
effectiveUnitPrice:
type: number
description: The effective price per unit after discounts. A numeric value.
externalId:
type: string
description: >-
An external identifier for the line item, used for integration
purposes.
id:
type: string
description: The unique identifier for the line item.
images:
type: string
description: A URL or reference to images associated with the line item.
isEditablePrice:
type: boolean
description: >-
Indicates whether the price of the line item is editable. A boolean
value.
isOptional:
type: boolean
description: Indicates whether the line item is optional. A boolean value.
isParent:
type: boolean
lineItemCurrencyCode:
type: string
description: The currency code for the line item, following ISO 4217 format.
mrr:
type: number
description: The monthly recurring revenue for the line item. A numeric value.
name:
type: string
description: The name of the line item.
parentLineItemId:
type: string
positionOnQuote:
type: integer
description: The position of the line item on a quote, represented as an integer.
format: int32
postTaxAmount:
type: number
description: The total amount after taxes are applied. A numeric value.
preDiscountAmount:
type: number
description: The amount before any discounts are applied. A numeric value.
price:
type: number
description: The price of a single unit of the line item. A numeric value.
priceBookId:
type: string
description: >-
The unique identifier for the price book associated with the line
item.
pricing:
$ref: '#/components/schemas/Pricing'
pricingModel:
type: string
description: >-
The pricing model used for the line item. Valid values include
'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
productId:
type: string
description: The unique identifier for the product associated with the line item.
productType:
type: string
description: The type of product associated with the line item.
quantity:
type: number
description: The quantity of the line item. A numeric value.
rampKey:
type: string
description: A unique identifier for the ramp associated with the line item.
recurringBillingDayOfMonth:
type: integer
description: >-
The day of the month on which recurring billing occurs, represented
as an integer.
format: int32
recurringBillingEndDate:
type: string
description: The end date for recurring billing, in ISO 8601 format.
format: date
recurringBillingFrequency:
type: string
description: >-
The frequency of recurring billing for the line item. Valid values
include 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS',
'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS',
'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'.
enum:
- ANNUALLY
- BIWEEKLY
- MONTHLY
- PER_FIVE_YEARS
- PER_FOUR_YEARS
- PER_SIX_MONTHS
- PER_THREE_YEARS
- PER_TWO_YEARS
- QUARTERLY
- WEEKLY
recurringBillingNumberOfPayments:
type: integer
description: >-
The number of payments in the recurring billing cycle, represented
as an integer.
format: int32
recurringBillingPeriod:
type: string
description: The period for recurring billing.
recurringBillingStartDate:
type: string
description: The start date for recurring billing, in ISO 8601 format.
format: date
recurringBillingTerms:
type: string
description: >-
The terms for recurring billing. Valid values include
'AUTOMATICALLY_RENEW' and 'FIXED'.
enum:
- AUTOMATICALLY_RENEW
- FIXED
richTextDescription:
type: string
description: A rich text description of the line item.
sku:
type: string
description: The stock keeping unit identifier for the line item.
tax:
type: number
description: The tax applied to the line item. A numeric value.
taxAmount:
type: number
taxCategory:
type: string
taxRateGroupId:
type: string
tcv:
type: number
description: The total contract value for the line item. A numeric value.
termInMonths:
type: integer
description: The term of the line item in months, represented as an integer.
format: int32
tierAmount:
type: number
description: The amount associated with a specific pricing tier. A numeric value.
totalDiscount:
type: number
description: The total discount amount applied to the line item. A numeric value.
updatedAt:
type: string
description: >-
The date and time when the line item was last updated, in ISO 8601
format.
format: date-time
variantId:
type: string
description: >-
The unique identifier for the product variant associated with the
line item.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
LineItemChangeRequest:
required:
- action
type: object
properties:
action:
type: string
description: >-
The action to be performed on the line item. Valid values include
'ADD', 'UPDATE', and 'REMOVE'.
enum:
- ADD
- REMOVE
- UPDATE
lineItemAdd:
description: >-
An object representing the details of the line item to be added.
This can be one of several types, such as a custom line item, a line
item from a product, or a cloned line item.
oneOf:
- $ref: '#/components/schemas/LineItemCustomCreateRequest'
- $ref: '#/components/schemas/LineItemFromProductCreateRequest'
- $ref: '#/components/schemas/LineItemCloneCreateRequest'
lineItemUpdate:
$ref: '#/components/schemas/LineItemChangeUpdate'
rampKey:
type: string
description: >-
A unique identifier for the ramp associated with the line item,
formatted as a UUID.
format: uuid
Pricing:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
An array of price entries, each detailing the currency and price for
the contract or line item.
items:
$ref: '#/components/schemas/PriceEntry'
pricingModel:
type: string
description: >-
The pricing model applied to the contract or line item. Valid values
include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
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.
LineItemCustomCreateRequest:
title: CUSTOM
required:
- mode
- name
- pricing
- quantity
type: object
properties:
allowBuyerSelectedQuantity:
type: boolean
description: >-
A boolean specifying if the buyer can select the quantity of the
line item.
billingCycleAnchorDate:
type: string
description: >-
A string in date format representing the anchor date for the billing
cycle.
format: date
billingStartDelayDays:
type: integer
description: >-
An integer indicating the number of days to delay the start of
billing.
format: int32
billingStartDelayMonths:
type: integer
description: >-
An integer specifying the number of months to delay the start of
billing.
format: int32
buyerSelectedQuantityMax:
type: number
description: A number representing the maximum quantity the buyer can select.
buyerSelectedQuantityMin:
type: number
description: A number representing the minimum quantity the buyer can select.
description:
type: string
description: A string providing a description of the line item.
discount:
type: number
description: A number representing the discount applied to the line item.
discountPercentage:
type: number
description: >-
A number indicating the percentage discount applied to the line
item.
externalId:
type: string
description: A string containing an external identifier for the line item.
images:
type: string
description: >-
A string containing URLs or references to images associated with the
line item.
isEditablePrice:
type: boolean
description: A boolean indicating if the price of the line item is editable.
isOptional:
type: boolean
description: A boolean indicating whether the line item is optional.
lineItemCurrencyCode:
type: string
description: A string representing the currency code for the line item.
mode:
type: string
description: >-
A string indicating the mode of the line item, with a default value
of 'CUSTOM'.
default: CUSTOM
enum:
- CUSTOM
name:
type: string
description: A string representing the name of the line item.
positionOnQuote:
type: integer
description: An integer indicating the position of the line item on a quote.
format: int32
priceBookId:
type: string
description: >-
A string representing the ID of the price book associated with the
line item.
pricing:
$ref: '#/components/schemas/PricingFullUpdateRequest'
productId:
type: string
description: A string identifying the product associated with the line item.
productType:
type: string
description: A string indicating the type of product for the line item.
quantity:
type: number
description: A number specifying the quantity of the line item.
recurringBillingEndDate:
type: string
description: >-
A string in date format indicating the end date of recurring
billing.
format: date
recurringBillingFrequency:
type: string
description: >-
A string specifying the frequency of recurring billing for the line
item, with valid values including 'ANNUALLY', 'BIWEEKLY', 'MONTHLY',
'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS',
'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'.
enum:
- ANNUALLY
- BIWEEKLY
- MONTHLY
- PER_FIVE_YEARS
- PER_FOUR_YEARS
- PER_SIX_MONTHS
- PER_THREE_YEARS
- PER_TWO_YEARS
- QUARTERLY
- WEEKLY
recurringBillingPeriod:
type: string
description: A string specifying the period of recurring billing.
recurringBillingStartDate:
type: string
description: >-
A string in date format representing the start date of recurring
billing.
format: date
richTextDescription:
type: string
description: A string containing a rich text description of the line item.
sku:
type: string
description: A string representing the stock keeping unit (SKU) of the line item.
taxCategory:
type: string
taxRateGroupId:
type: string
variantId:
type: string
description: A string identifying the variant of the product for the line item.
x-hubspot-sub-type-impl: true
LineItemFromProductCreateRequest:
title: FROM_PRODUCT
required:
- allowBuyerSelectedQuantity
- billingCycleAnchorDate
- billingStartDelayDays
- billingStartDelayMonths
- buyerSelectedQuantityMax
- buyerSelectedQuantityMin
- description
- discount
- discountPercentage
- externalId
- images
- isEditablePrice
- isOptional
- lineItemCurrencyCode
- mode
- name
- positionOnQuote
- priceBookId
- pricing
- productId
- productType
- quantity
- recurringBillingEndDate
- recurringBillingFrequency
- recurringBillingPeriod
- recurringBillingStartDate
- richTextDescription
- sku
- taxCategory
- taxRateGroupId
- variantId
type: object
properties:
allowBuyerSelectedQuantity:
type: object
properties: {}
description: >-
An object indicating whether the buyer can select the quantity of
the line item.
billingCycleAnchorDate:
type: object
properties: {}
description: An object representing the anchor date for the billing cycle.
billingStartDelayDays:
type: object
properties: {}
description: >-
An object representing the number of days to delay the start of
billing.
billingStartDelayMonths:
type: object
properties: {}
description: >-
An object representing the number of months to delay the start of
billing.
buyerSelectedQuantityMax:
type: object
properties: {}
description: An object representing the maximum quantity the buyer can select.
buyerSelectedQuantityMin:
type: object
properties: {}
description: An object representing the minimum quantity the buyer can select.
description:
type: object
properties: {}
description: An object representing the description of the line item.
discount:
type: object
properties: {}
description: An object representing the discount applied to the line item.
discountPercentage:
type: object
properties: {}
description: >-
An object representing the percentage discount applied to the line
item.
externalId:
type: object
properties: {}
description: An object representing an external identifier for the line item.
images:
type: object
properties: {}
description: An object representing the images associated with the line item.
isEditablePrice:
type: object
properties: {}
description: An object indicating whether the price of the line item is editable.
isOptional:
type: object
properties: {}
description: An object indicating whether the line item is optional.
lineItemCurrencyCode:
type: object
properties: {}
description: An object representing the currency code for the line item.
mode:
type: string
description: >-
A string indicating the mode of the line item creation, defaulting
to 'FROM_PRODUCT'.
default: FROM_PRODUCT
enum:
- FROM_PRODUCT
name:
type: object
properties: {}
description: An object representing the name of the line item.
positionOnQuote:
type: object
properties: {}
description: An object representing the position of the line item on the quote.
priceBookId:
type: object
properties: {}
description: >-
An object representing the ID of the price book associated with the
line item.
pricing:
type: object
properties: {}
description: An object representing the pricing details of the line item.
productId:
type: string
description: >-
A string representing the ID of the product associated with the line
item.
productType:
type: object
properties: {}
description: An object representing the type of product for the line item.
quantity:
type: object
properties: {}
description: An object representing the quantity of the product in the line item.
recurringBillingEndDate:
type: object
properties: {}
description: An object representing the end date for recurring billing.
recurringBillingFrequency:
type: object
properties: {}
description: >-
An object representing the frequency of recurring billing for the
line item.
recurringBillingPeriod:
type: object
properties: {}
description: An object representing the period of recurring billing.
recurringBillingStartDate:
type: object
properties: {}
description: An object representing the start date for recurring billing.
richTextDescription:
type: object
properties: {}
description: An object representing the rich text description of the line item.
sku:
type: object
properties: {}
description: An object representing the stock keeping unit (SKU) of the product.
taxCategory:
type: object
properties: {}
taxRateGroupId:
type: object
properties: {}
variantId:
type: object
properties: {}
description: An object representing the variant ID of the product.
x-hubspot-sub-type-impl: true
LineItemCloneCreateRequest:
title: CLONE
required:
- allowBuyerSelectedQuantity
- billingCycleAnchorDate
- billingStartDelayDays
- billingStartDelayMonths
- buyerSelectedQuantityMax
- buyerSelectedQuantityMin
- description
- discount
- discountPercentage
- externalId
- images
- isEditablePrice
- isOptional
- lineItemCurrencyCode
- mode
- name
- positionOnQuote
- priceBookId
- pricing
- productType
- quantity
- recurringBillingEndDate
- recurringBillingFrequency
- recurringBillingPeriod
- recurringBillingStartDate
- richTextDescription
- sku
- sourceLineItemId
- taxCategory
- taxRateGroupId
- variantId
type: object
properties:
allowBuyerSelectedQuantity:
type: object
properties: {}
description: >-
An object indicating whether the buyer can select the quantity of
the line item.
billingCycleAnchorDate:
type: object
properties: {}
description: >-
An object representing the anchor date for the billing cycle of the
line item.
billingStartDelayDays:
type: object
properties: {}
description: >-
An object representing the number of days to delay the start of
billing for the line item.
billingStartDelayMonths:
type: object
properties: {}
description: >-
An object representing the number of months to delay the start of
billing for the line item.
buyerSelectedQuantityMax:
type: object
properties: {}
description: >-
An object representing the maximum quantity that the buyer can
select for the line item.
buyerSelectedQuantityMin:
type: object
properties: {}
description: >-
An object representing the minimum quantity that the buyer can
select for the line item.
description:
type: object
properties: {}
description: An object representing the description of the line item.
discount:
type: object
properties: {}
description: An object representing the discount applied to the line item.
discountPercentage:
type: object
properties: {}
description: >-
An object representing the percentage discount applied to the line
item.
externalId:
type: object
properties: {}
description: An object representing an external identifier for the line item.
images:
type: object
properties: {}
description: An object representing the images associated with the line item.
isEditablePrice:
type: object
properties: {}
description: An object indicating whether the price of the line item is editable.
isOptional:
type: object
properties: {}
description: An object indicating whether the line item is optional.
lineItemCurrencyCode:
type: object
properties: {}
description: An object representing the currency code for the line item.
mode:
type: string
description: >-
A string indicating the mode of the line item creation, which is
'CLONE' by default.
default: CLONE
enum:
- CLONE
name:
type: object
properties: {}
description: An object representing the name of the line item.
positionOnQuote:
type: object
properties: {}
description: An object representing the position of the line item on the quote.
priceBookId:
type: object
properties: {}
description: >-
An object representing the ID of the price book associated with the
line item.
pricing:
type: object
properties: {}
description: An object representing the pricing details of the line item.
productType:
type: object
properties: {}
description: An object representing the type of product for the line item.
quantity:
type: object
properties: {}
description: An object representing the quantity of the line item.
recurringBillingEndDate:
type: object
properties: {}
description: >-
An object representing the end date for recurring billing of the
line item.
recurringBillingFrequency:
type: object
properties: {}
description: >-
An object representing the frequency of recurring billing for the
line item.
recurringBillingPeriod:
type: object
properties: {}
description: >-
An object representing the billing period for recurring billing of
the line item.
recurringBillingStartDate:
type: object
properties: {}
description: >-
An object representing the start date for recurring billing of the
line item.
richTextDescription:
type: object
properties: {}
description: An object representing the rich text description of the line item.
sku:
type: object
properties: {}
description: >-
An object representing the stock keeping unit (SKU) of the line
item.
sourceLineItemId:
type: string
description: A string representing the ID of the source line item being cloned.
taxCategory:
type: object
properties: {}
taxRateGroupId:
type: object
properties: {}
variantId:
type: object
properties: {}
description: An object representing the variant ID of the line item.
x-hubspot-sub-type-impl: true
LineItemChangeUpdate:
required:
- allowBuyerSelectedQuantity
- billingCycleAnchorDate
- billingStartDelayDays
- billingStartDelayMonths
- buyerSelectedQuantityMax
- buyerSelectedQuantityMin
- description
- discount
- discountPercentage
- externalId
- images
- isEditablePrice
- isOptional
- lineItemCurrencyCode
- name
- positionOnQuote
- priceBookId
- pricing
- productType
- quantity
- recurringBillingEndDate
- recurringBillingFrequency
- recurringBillingPeriod
- recurringBillingStartDate
- richTextDescription
- sku
- taxCategory
- taxRateGroupId
- variantId
type: object
properties:
allowBuyerSelectedQuantity:
type: object
properties: {}
description: >-
An object indicating whether the buyer is allowed to select the
quantity of the line item.
billingCycleAnchorDate:
type: object
properties: {}
description: >-
An object representing the anchor date for the billing cycle of the
line item.
billingStartDelayDays:
type: object
properties: {}
description: >-
An object representing the number of days to delay the start of
billing for the line item.
billingStartDelayMonths:
type: object
properties: {}
description: >-
An object representing the number of months to delay the start of
billing for the line item.
buyerSelectedQuantityMax:
type: object
properties: {}
description: >-
An object representing the maximum quantity that the buyer can
select for the line item.
buyerSelectedQuantityMin:
type: object
properties: {}
description: >-
An object representing the minimum quantity that the buyer can
select for the line item.
description:
type: object
properties: {}
description: An object representing the description of the line item.
discount:
type: object
properties: {}
description: An object representing the discount applied to the line item.
discountPercentage:
type: object
properties: {}
description: >-
An object representing the discount percentage applied to the line
item.
externalId:
type: object
properties: {}
description: An object representing the external ID of the line item.
images:
type: object
properties: {}
description: An object representing the images associated with the line item.
isEditablePrice:
type: object
properties: {}
description: An object indicating whether the price of the line item is editable.
isOptional:
type: object
properties: {}
description: An object indicating whether the line item is optional.
lineItemCurrencyCode:
type: object
properties: {}
description: An object representing the currency code for the line item.
name:
type: object
properties: {}
description: An object representing the name of the line item.
positionOnQuote:
type: object
properties: {}
description: An object representing the position of the line item on the quote.
priceBookId:
type: object
properties: {}
description: >-
An object representing the price book ID associated with the line
item.
pricing:
type: object
properties: {}
description: An object representing the pricing details of the line item.
productType:
type: object
properties: {}
description: An object representing the type of product for the line item.
quantity:
type: object
properties: {}
description: An object representing the quantity of the line item.
recurringBillingEndDate:
type: object
properties: {}
description: >-
An object representing the end date for recurring billing of the
line item.
recurringBillingFrequency:
type: object
properties: {}
description: >-
An object representing the frequency of recurring billing for the
line item.
recurringBillingPeriod:
type: object
properties: {}
description: >-
An object representing the billing period for recurring billing of
the line item.
recurringBillingStartDate:
type: object
properties: {}
description: >-
An object representing the start date for recurring billing of the
line item.
richTextDescription:
type: object
properties: {}
description: An object representing the rich text description of the line item.
sku:
type: object
properties: {}
description: >-
An object representing the stock keeping unit (SKU) of the line
item.
taxCategory:
type: object
properties: {}
description: An object representing the tax category of the line item.
taxRateGroupId:
type: object
properties: {}
description: An object representing the tax rate group ID for the line item.
variantId:
type: object
properties: {}
description: An object representing the variant ID of the line item.
PriceEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: >-
The currency code in which the price is denominated, represented as
a string.
maxQuantity:
type: integer
description: >-
The maximum quantity applicable for this price entry, represented as
a string.
format: int32
price:
type: number
description: >-
The monetary value of the product or service, represented as a
number.
PricingFullUpdateRequest:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
An array of PriceUpdateEntry objects, each representing a price
entry with details such as currency code and price.
items:
$ref: '#/components/schemas/PriceUpdateEntry'
pricingModel:
type: string
description: >-
A string representing the pricing model used. Valid values include
'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
PriceUpdateEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: >-
The currency code in which the price is denominated, represented as
a string.
maxQuantity:
type: integer
description: >-
The maximum quantity for which this price is applicable, represented
as a string.
format: int32
price:
type: object
properties: {}
description: >-
The price value associated with the currency code, represented as an
object.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
contracts-read: ''
revenue-contracts-public-api-write: ''
````
{product.name} -
{product.level}
)}