Preview Changes
curl --request POST \
--url https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview \
--header 'Content-Type: application/json' \
--data '
{
"autoAccept": true,
"lineItemChanges": [
{
"lineItemAdd": {
"mode": "CUSTOM",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
]
},
"quantity": 123,
"allowBuyerSelectedQuantity": true,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
},
"rampKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"prorating": true,
"type": "DIRECT",
"contractId": "<string>",
"effectiveDate": "2023-12-25",
"name": "<string>"
}
'import requests
url = "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview"
payload = {
"autoAccept": True,
"lineItemChanges": [
{
"lineItemAdd": {
"mode": "CUSTOM",
"name": "<string>",
"pricing": { "prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
] },
"quantity": 123,
"allowBuyerSelectedQuantity": True,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": True,
"isOptional": True,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
},
"rampKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"prorating": True,
"type": "DIRECT",
"contractId": "<string>",
"effectiveDate": "2023-12-25",
"name": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
autoAccept: true,
lineItemChanges: [
{
lineItemAdd: {
mode: 'CUSTOM',
name: '<string>',
pricing: {prices: [{currencyCode: '<string>', price: {}, maxQuantity: 123}]},
quantity: 123,
allowBuyerSelectedQuantity: true,
billingCycleAnchorDate: '2023-12-25',
billingStartDelayDays: 123,
billingStartDelayMonths: 123,
buyerSelectedQuantityMax: 123,
buyerSelectedQuantityMin: 123,
description: '<string>',
discount: 123,
discountPercentage: 123,
externalId: '<string>',
images: '<string>',
isEditablePrice: true,
isOptional: true,
lineItemCurrencyCode: '<string>',
positionOnQuote: 123,
priceBookId: '<string>',
productId: '<string>',
productType: '<string>',
recurringBillingEndDate: '2023-12-25',
recurringBillingPeriod: '<string>',
recurringBillingStartDate: '2023-12-25',
richTextDescription: '<string>',
sku: '<string>',
taxCategory: '<string>',
taxRateGroupId: '<string>',
variantId: '<string>'
},
rampKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
prorating: true,
type: 'DIRECT',
contractId: '<string>',
effectiveDate: '2023-12-25',
name: '<string>'
})
};
fetch('https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoAccept' => true,
'lineItemChanges' => [
[
'lineItemAdd' => [
'mode' => 'CUSTOM',
'name' => '<string>',
'pricing' => [
'prices' => [
[
'currencyCode' => '<string>',
'price' => [
],
'maxQuantity' => 123
]
]
],
'quantity' => 123,
'allowBuyerSelectedQuantity' => true,
'billingCycleAnchorDate' => '2023-12-25',
'billingStartDelayDays' => 123,
'billingStartDelayMonths' => 123,
'buyerSelectedQuantityMax' => 123,
'buyerSelectedQuantityMin' => 123,
'description' => '<string>',
'discount' => 123,
'discountPercentage' => 123,
'externalId' => '<string>',
'images' => '<string>',
'isEditablePrice' => true,
'isOptional' => true,
'lineItemCurrencyCode' => '<string>',
'positionOnQuote' => 123,
'priceBookId' => '<string>',
'productId' => '<string>',
'productType' => '<string>',
'recurringBillingEndDate' => '2023-12-25',
'recurringBillingPeriod' => '<string>',
'recurringBillingStartDate' => '2023-12-25',
'richTextDescription' => '<string>',
'sku' => '<string>',
'taxCategory' => '<string>',
'taxRateGroupId' => '<string>',
'variantId' => '<string>'
],
'rampKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'prorating' => true,
'type' => 'DIRECT',
'contractId' => '<string>',
'effectiveDate' => '2023-12-25',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview"
payload := strings.NewReader("{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview")
.header("Content-Type", "application/json")
.body("{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deltaLineItems": [
{
"id": "<string>",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": 123,
"maxQuantity": 123
}
],
"pricingModel": "FLAT"
},
"quantity": 123,
"acv": 123,
"allowBuyerSelectedQuantity": true,
"amount": 123,
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"arr": 123,
"billingCycleAnchorDate": "2023-12-25",
"billingPeriodEndDate": "2023-12-25",
"billingPeriodStartDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"billingStartDelayType": "HS_BILLING_START_DELAY_DAYS",
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"effectiveUnitPrice": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"isParent": true,
"lineItemCurrencyCode": "<string>",
"mrr": 123,
"parentLineItemId": "<string>",
"positionOnQuote": 123,
"postTaxAmount": 123,
"preDiscountAmount": 123,
"price": 123,
"priceBookId": "<string>",
"pricingModel": "FLAT",
"productId": "<string>",
"productType": "<string>",
"rampKey": "<string>",
"recurringBillingDayOfMonth": 123,
"recurringBillingEndDate": "2023-12-25",
"recurringBillingFrequency": "ANNUALLY",
"recurringBillingNumberOfPayments": 123,
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"recurringBillingTerms": "AUTOMATICALLY_RENEW",
"richTextDescription": "<string>",
"sku": "<string>",
"tax": 123,
"taxAmount": 123,
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"tcv": 123,
"termInMonths": 123,
"tierAmount": 123,
"totalDiscount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"variantId": "<string>"
}
],
"proposedLineItems": [
{
"id": "<string>",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": 123,
"maxQuantity": 123
}
],
"pricingModel": "FLAT"
},
"quantity": 123,
"acv": 123,
"allowBuyerSelectedQuantity": true,
"amount": 123,
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"arr": 123,
"billingCycleAnchorDate": "2023-12-25",
"billingPeriodEndDate": "2023-12-25",
"billingPeriodStartDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"billingStartDelayType": "HS_BILLING_START_DELAY_DAYS",
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"effectiveUnitPrice": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"isParent": true,
"lineItemCurrencyCode": "<string>",
"mrr": 123,
"parentLineItemId": "<string>",
"positionOnQuote": 123,
"postTaxAmount": 123,
"preDiscountAmount": 123,
"price": 123,
"priceBookId": "<string>",
"pricingModel": "FLAT",
"productId": "<string>",
"productType": "<string>",
"rampKey": "<string>",
"recurringBillingDayOfMonth": 123,
"recurringBillingEndDate": "2023-12-25",
"recurringBillingFrequency": "ANNUALLY",
"recurringBillingNumberOfPayments": 123,
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"recurringBillingTerms": "AUTOMATICALLY_RENEW",
"richTextDescription": "<string>",
"sku": "<string>",
"tax": 123,
"taxAmount": 123,
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"tcv": 123,
"termInMonths": 123,
"tierAmount": 123,
"totalDiscount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"variantId": "<string>"
}
]
}{
"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"
}
}Changes
Preview Changes
Preview the changes to a commerce contract before they are applied. This endpoint allows you to simulate contract modifications, providing a preview of the resulting changes without committing them. It is useful for assessing the impact of proposed changes on a contract.
POST
/
commerce
/
contracts
/
2027-03-beta
/
changes
/
preview
Preview Changes
curl --request POST \
--url https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview \
--header 'Content-Type: application/json' \
--data '
{
"autoAccept": true,
"lineItemChanges": [
{
"lineItemAdd": {
"mode": "CUSTOM",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
]
},
"quantity": 123,
"allowBuyerSelectedQuantity": true,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
},
"rampKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"prorating": true,
"type": "DIRECT",
"contractId": "<string>",
"effectiveDate": "2023-12-25",
"name": "<string>"
}
'import requests
url = "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview"
payload = {
"autoAccept": True,
"lineItemChanges": [
{
"lineItemAdd": {
"mode": "CUSTOM",
"name": "<string>",
"pricing": { "prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
] },
"quantity": 123,
"allowBuyerSelectedQuantity": True,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": True,
"isOptional": True,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
},
"rampKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"prorating": True,
"type": "DIRECT",
"contractId": "<string>",
"effectiveDate": "2023-12-25",
"name": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
autoAccept: true,
lineItemChanges: [
{
lineItemAdd: {
mode: 'CUSTOM',
name: '<string>',
pricing: {prices: [{currencyCode: '<string>', price: {}, maxQuantity: 123}]},
quantity: 123,
allowBuyerSelectedQuantity: true,
billingCycleAnchorDate: '2023-12-25',
billingStartDelayDays: 123,
billingStartDelayMonths: 123,
buyerSelectedQuantityMax: 123,
buyerSelectedQuantityMin: 123,
description: '<string>',
discount: 123,
discountPercentage: 123,
externalId: '<string>',
images: '<string>',
isEditablePrice: true,
isOptional: true,
lineItemCurrencyCode: '<string>',
positionOnQuote: 123,
priceBookId: '<string>',
productId: '<string>',
productType: '<string>',
recurringBillingEndDate: '2023-12-25',
recurringBillingPeriod: '<string>',
recurringBillingStartDate: '2023-12-25',
richTextDescription: '<string>',
sku: '<string>',
taxCategory: '<string>',
taxRateGroupId: '<string>',
variantId: '<string>'
},
rampKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
prorating: true,
type: 'DIRECT',
contractId: '<string>',
effectiveDate: '2023-12-25',
name: '<string>'
})
};
fetch('https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoAccept' => true,
'lineItemChanges' => [
[
'lineItemAdd' => [
'mode' => 'CUSTOM',
'name' => '<string>',
'pricing' => [
'prices' => [
[
'currencyCode' => '<string>',
'price' => [
],
'maxQuantity' => 123
]
]
],
'quantity' => 123,
'allowBuyerSelectedQuantity' => true,
'billingCycleAnchorDate' => '2023-12-25',
'billingStartDelayDays' => 123,
'billingStartDelayMonths' => 123,
'buyerSelectedQuantityMax' => 123,
'buyerSelectedQuantityMin' => 123,
'description' => '<string>',
'discount' => 123,
'discountPercentage' => 123,
'externalId' => '<string>',
'images' => '<string>',
'isEditablePrice' => true,
'isOptional' => true,
'lineItemCurrencyCode' => '<string>',
'positionOnQuote' => 123,
'priceBookId' => '<string>',
'productId' => '<string>',
'productType' => '<string>',
'recurringBillingEndDate' => '2023-12-25',
'recurringBillingPeriod' => '<string>',
'recurringBillingStartDate' => '2023-12-25',
'richTextDescription' => '<string>',
'sku' => '<string>',
'taxCategory' => '<string>',
'taxRateGroupId' => '<string>',
'variantId' => '<string>'
],
'rampKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'prorating' => true,
'type' => 'DIRECT',
'contractId' => '<string>',
'effectiveDate' => '2023-12-25',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview"
payload := strings.NewReader("{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview")
.header("Content-Type", "application/json")
.body("{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/contracts/2027-03-beta/changes/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoAccept\": true,\n \"lineItemChanges\": [\n {\n \"lineItemAdd\": {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n },\n \"rampKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"prorating\": true,\n \"type\": \"DIRECT\",\n \"contractId\": \"<string>\",\n \"effectiveDate\": \"2023-12-25\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deltaLineItems": [
{
"id": "<string>",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": 123,
"maxQuantity": 123
}
],
"pricingModel": "FLAT"
},
"quantity": 123,
"acv": 123,
"allowBuyerSelectedQuantity": true,
"amount": 123,
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"arr": 123,
"billingCycleAnchorDate": "2023-12-25",
"billingPeriodEndDate": "2023-12-25",
"billingPeriodStartDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"billingStartDelayType": "HS_BILLING_START_DELAY_DAYS",
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"effectiveUnitPrice": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"isParent": true,
"lineItemCurrencyCode": "<string>",
"mrr": 123,
"parentLineItemId": "<string>",
"positionOnQuote": 123,
"postTaxAmount": 123,
"preDiscountAmount": 123,
"price": 123,
"priceBookId": "<string>",
"pricingModel": "FLAT",
"productId": "<string>",
"productType": "<string>",
"rampKey": "<string>",
"recurringBillingDayOfMonth": 123,
"recurringBillingEndDate": "2023-12-25",
"recurringBillingFrequency": "ANNUALLY",
"recurringBillingNumberOfPayments": 123,
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"recurringBillingTerms": "AUTOMATICALLY_RENEW",
"richTextDescription": "<string>",
"sku": "<string>",
"tax": 123,
"taxAmount": 123,
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"tcv": 123,
"termInMonths": 123,
"tierAmount": 123,
"totalDiscount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"variantId": "<string>"
}
],
"proposedLineItems": [
{
"id": "<string>",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": 123,
"maxQuantity": 123
}
],
"pricingModel": "FLAT"
},
"quantity": 123,
"acv": 123,
"allowBuyerSelectedQuantity": true,
"amount": 123,
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"arr": 123,
"billingCycleAnchorDate": "2023-12-25",
"billingPeriodEndDate": "2023-12-25",
"billingPeriodStartDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"billingStartDelayType": "HS_BILLING_START_DELAY_DAYS",
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"effectiveUnitPrice": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"isParent": true,
"lineItemCurrencyCode": "<string>",
"mrr": 123,
"parentLineItemId": "<string>",
"positionOnQuote": 123,
"postTaxAmount": 123,
"preDiscountAmount": 123,
"price": 123,
"priceBookId": "<string>",
"pricingModel": "FLAT",
"productId": "<string>",
"productType": "<string>",
"rampKey": "<string>",
"recurringBillingDayOfMonth": 123,
"recurringBillingEndDate": "2023-12-25",
"recurringBillingFrequency": "ANNUALLY",
"recurringBillingNumberOfPayments": 123,
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"recurringBillingTerms": "AUTOMATICALLY_RENEW",
"richTextDescription": "<string>",
"sku": "<string>",
"tax": 123,
"taxAmount": 123,
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"tcv": 123,
"termInMonths": 123,
"tierAmount": 123,
"totalDiscount": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"variantId": "<string>"
}
]
}{
"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"
}
}Supported products
Supported products
Required Scopes
Required Scopes
Body
application/json
- Option 1
- Option 2
A boolean indicating whether the contract change should be automatically accepted.
An array of line item changes to be applied to the contract. Each item in the array is a LineItemChangeRequest object.
Show child attributes
Show child attributes
A boolean indicating whether the contract change should be prorated.
A string that specifies the type of contract change. The default and only valid value is 'DIRECT'.
Available options:
DIRECT A string that uniquely identifies the contract to which the change applies.
A string representing the date when the contract change becomes effective, in the format 'date'.
A string representing the name of the contract change.
Response
successful operation
An array of LineItem objects representing the changes in line items compared to the current state of the contract.
Show child attributes
Show child attributes
An array of LineItem objects representing the proposed state of line items after the changes are applied.
Show child attributes
Show child attributes
Last modified on September 9, 2026
Was this page helpful?