> ## 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.
# Accept Change
> Accept a specific contract change in the HubSpot commerce system. This endpoint is used to finalize and apply changes to a contract that have been proposed. It requires the unique identifier of the change to be accepted.
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/{changeId}/accept
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/{changeId}/accept:
post:
tags:
- Changes
summary: Accept change
description: >-
Accept a specific contract change in the HubSpot commerce system. This
endpoint is used to finalize and apply changes to a contract that have
been proposed. It requires the unique identifier of the change to be
accepted.
operationId: post-/commerce/contracts/2027-03-beta/changes/{changeId}/accept
parameters:
- name: changeId
in: path
description: The unique identifier of the contract change to accept.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ContractChangeResponse'
default:
$ref: '#/components/responses/Error'
description: ''
security: []
components:
schemas:
ContractChangeResponse:
required:
- contractId
- deltaLineItems
- id
- lineItemChanges
- proposedLineItems
- prorating
- status
- type
type: object
properties:
contractId:
type: string
description: The unique identifier of the contract associated with this change.
createdAt:
type: string
description: >-
The date and time when the contract change was created, in ISO 8601
format.
format: date-time
deltaLineItems:
type: array
description: >-
An array of line items that represent the difference resulting from
the contract change.
items:
$ref: '#/components/schemas/LineItem'
effectiveDate:
type: string
description: >-
The date when the contract change becomes effective, in YYYY-MM-DD
format.
format: date
id:
type: string
description: The unique identifier for the contract change.
lineItemChanges:
type: array
description: >-
An array of changes to line items associated with the contract
change.
items:
$ref: '#/components/schemas/LineItemChangeResponse'
name:
type: string
description: The name of the contract change.
proposedLineItems:
type: array
description: >-
An array of line items that are proposed as part of the contract
change.
items:
$ref: '#/components/schemas/LineItem'
prorating:
type: boolean
description: A boolean indicating whether the contract change involves prorating.
quoteId:
type: string
description: >-
The unique identifier of the quote associated with this contract
change.
status:
type: string
description: >-
The current status of the contract change. Valid values include
'DRAFT', 'PROPOSED', 'ACCEPTED', 'CANCELED', 'FAILED', and
'EXPIRED'.
enum:
- ACCEPTED
- CANCELED
- DRAFT
- EXPIRED
- FAILED
- PROPOSED
type:
type: string
description: >-
The type of contract change. Valid values include 'DIRECT' and
'QUOTE'.
enum:
- DIRECT
- QUOTE
updatedAt:
type: string
description: >-
The date and time when the contract change was last updated, in ISO
8601 format.
format: date-time
LineItem:
required:
- id
- name
- pricing
- quantity
type: object
properties:
acv:
type: number
description: The annual contract value for this line item. A number.
allowBuyerSelectedQuantity:
type: boolean
description: >-
Indicates whether the buyer can select the quantity of this line
item. A boolean value.
amount:
type: number
description: >-
The total amount for this line item, calculated as price multiplied
by quantity. A number.
archived:
type: boolean
description: Indicates whether this line item is archived. A boolean value.
archivedAt:
type: string
description: >-
The date and time when this line item was archived, in ISO 8601
format.
format: date-time
arr:
type: number
description: The annual recurring revenue for this line item. A number.
billingCycleAnchorDate:
type: string
description: The anchor date for the billing cycle, in ISO 8601 date format.
format: date
billingPeriodEndDate:
type: string
description: The end date of the billing period, in ISO 8601 date format.
format: date
billingPeriodStartDate:
type: string
description: The start date of the billing period, in ISO 8601 date format.
format: date
billingStartDelayDays:
type: integer
description: The delay in days before billing starts. An integer.
format: int32
billingStartDelayMonths:
type: integer
description: The delay in months before billing starts. An integer.
format: int32
billingStartDelayType:
type: string
description: >-
The type of delay before billing starts. 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 the buyer can select for this line item. A
number.
buyerSelectedQuantityMin:
type: number
description: >-
The minimum quantity the buyer can select for this line item. A
number.
createdAt:
type: string
description: >-
The date and time when this 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 this line item. A number.
discountPercentage:
type: number
description: The discount percentage applied to this line item. A number.
effectiveUnitPrice:
type: number
description: The effective price per unit after discounts. A number.
externalId:
type: string
description: An external identifier for this line item.
id:
type: string
description: The unique identifier for this line item.
images:
type: string
description: A URL or reference to images associated with this line item.
isEditablePrice:
type: boolean
description: >-
Indicates whether the price of this line item is editable. A boolean
value.
isOptional:
type: boolean
description: Indicates whether this line item is optional. A boolean value.
isParent:
type: boolean
description: Indicates whether this line item is a parent item. A boolean value.
lineItemCurrencyCode:
type: string
description: The currency code for this line item, following ISO 4217 format.
mrr:
type: number
description: The monthly recurring revenue for this line item. A number.
name:
type: string
description: The name of the line item.
parentLineItemId:
type: string
description: The unique identifier for the parent line item, if applicable.
positionOnQuote:
type: integer
description: The position of this line item on a quote. An integer.
format: int32
postTaxAmount:
type: number
description: The total amount after tax is applied. A number.
preDiscountAmount:
type: number
description: The amount before any discounts are applied. A number.
price:
type: number
description: The price of a single unit of the line item. A number.
priceBookId:
type: string
description: >-
The unique identifier for the price book associated with this line
item.
pricing:
$ref: '#/components/schemas/Pricing'
pricingModel:
type: string
description: >-
The pricing model used for this 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 this line
item.
productType:
type: string
description: The type of product for this line item.
quantity:
type: number
description: The quantity of the line item. A number.
rampKey:
type: string
description: A unique identifier for the ramp associated with this line item.
recurringBillingDayOfMonth:
type: integer
description: The day of the month on which recurring billing occurs. An integer.
format: int32
recurringBillingEndDate:
type: string
description: The end date for recurring billing, in ISO 8601 date format.
format: date
recurringBillingFrequency:
type: string
description: >-
The frequency of recurring billing for this 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 for recurring billing. 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 date 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 (SKU) for this line item.
tax:
type: number
description: The tax rate applied to this line item. A number.
taxAmount:
type: number
description: The total tax amount for this line item. A number.
taxCategory:
type: string
description: The tax category for this line item.
taxRateGroupId:
type: string
description: >-
The unique identifier for the tax rate group associated with this
line item.
tcv:
type: number
description: The total contract value for this line item. A number.
termInMonths:
type: integer
description: The term length in months for this line item. An integer.
format: int32
tierAmount:
type: number
description: The amount for the current pricing tier. A number.
totalDiscount:
type: number
description: The total discount amount for this line item. A number.
updatedAt:
type: string
description: >-
The date and time when this 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 this
line item.
LineItemChangeResponse:
required:
- action
- rampKey
type: object
properties:
action:
type: string
description: >-
The type of action performed on the line item. Valid values include
'ADD', 'UPDATE', and 'REMOVE'.
enum:
- ADD
- REMOVE
- UPDATE
lineItemAdd:
description: >-
An object representing the added line item details if the action was
'ADD'. This can be one of several types, such as custom, from a
product, or a clone.
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 line item change, formatted as a UUID.
format: uuid
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, provided as an object with
additional properties that are arrays of strings.
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. It is formatted as a UUID.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
Further information about the error, represented as an array of
ErrorDetail objects.
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
Pricing:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
An array of price entries, each specifying a currency code and the
corresponding price for the line item.
items:
$ref: '#/components/schemas/PriceEntry'
pricingModel:
type: string
description: >-
The pricing model applied to the line item. Valid values include
'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
LineItemCustomCreateRequest:
title: CUSTOM
required:
- mode
- name
- pricing
- quantity
type: object
properties:
allowBuyerSelectedQuantity:
type: boolean
description: >-
A boolean indicating 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 delay in days before billing starts.
format: int32
billingStartDelayMonths:
type: integer
description: An integer representing the delay in months before billing starts.
format: int32
buyerSelectedQuantityMax:
type: number
description: A number representing the maximum quantity the buyer can select.
buyerSelectedQuantityMin:
type: number
description: A number indicating 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 amount applied to the line item.
discountPercentage:
type: number
description: >-
A number indicating the discount percentage applied to the line
item.
externalId:
type: string
description: A string representing an external identifier for the line item.
images:
type: string
description: A string containing image URLs associated with the line item.
isEditablePrice:
type: boolean
description: A boolean indicating whether 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 indicating the currency code for the line item.
mode:
type: string
description: >-
A string indicating the mode of the line item, which is 'CUSTOM' by
default.
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 the quote.
format: int32
priceBookId:
type: string
description: A string indicating the price book ID associated with the line item.
pricing:
$ref: '#/components/schemas/PricingFullUpdateRequest'
productId:
type: string
description: A string representing the product ID 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 indicating the quantity of the line item.
recurringBillingEndDate:
type: string
description: >-
A string in date format representing the end date for recurring
billing.
format: date
recurringBillingFrequency:
type: string
description: >-
A string representing the frequency of recurring billing, with valid
values including 'ANNUALLY', 'BIWEEKLY', 'MONTHLY',
'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS',
'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', '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 indicating the period for recurring billing.
recurringBillingStartDate:
type: string
description: >-
A string in date format indicating the start date for 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
description: A string representing the tax category for the line item.
taxRateGroupId:
type: string
description: >-
A string indicating the tax rate group ID applicable to the line
item.
variantId:
type: string
description: A string representing the variant ID of the product.
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 delay in days before billing starts.
billingStartDelayMonths:
type: object
properties: {}
description: An object representing the delay in months before billing starts.
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 providing a 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 an external identifier for the line item.
images:
type: object
properties: {}
description: An object containing 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, with a
default value of '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 indicating 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 for 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 providing a 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: {}
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 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 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 discount percentage 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, with a default value
of 'CLONE'.
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 period of recurring billing for 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: {}
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.
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 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 a buyer can select
for the line item.
buyerSelectedQuantityMin:
type: object
properties: {}
description: >-
An object representing the minimum quantity that a 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.
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.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: >-
The status code associated with the error detail, represented as a
string.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object where
each key is a string and each value is an array of strings. This
provides additional information about the error.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found.
This is an optional string field.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required field and is of type
string.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error, provided as a string.
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.
PriceEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: >-
The currency 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 an integer.
format: int32
price:
type: number
description: >-
The cost of the product or service in the specified currency,
represented as a number.
PricingFullUpdateRequest:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
An array of price entries that define the specific pricing details
for the contract. Each entry includes currency and price
information.
items:
$ref: '#/components/schemas/PriceUpdateEntry'
pricingModel:
type: string
description: >-
The pricing model applied to the contract. Valid values include
'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
PriceUpdateEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: A string representing the currency in which the price is specified.
maxQuantity:
type: integer
description: >-
An integer indicating the maximum quantity applicable for this price
entry.
format: int32
price:
type: object
properties: {}
description: An object representing the price details for the entry.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
````
{product.name} -
{product.level}
)}