Update contract

Atualizar contrato

curl --request PATCH \
  --url https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "automatedTaxesEnabled": {},
  "billingAddress": {},
  "billingCompanyId": {},
  "billingContactId": {},
  "billingStartDateOverride": {},
  "dealId": {},
  "externalPaymentMethodReferenceId": {},
  "locale": {},
  "name": {},
  "netPaymentTerms": {},
  "ownerId": {},
  "poNumber": {},
  "sellerCompanyAddress": {},
  "sellerCompanyDomain": {},
  "sellerCompanyName": {},
  "sellerEmail": {},
  "sellerFirstName": {},
  "sellerLastName": {},
  "sellerPhone": {},
  "addressTypesToCollect": [],
  "allowedPaymentMethods": [],
  "customProperties": {}
}
'

import requests

url = "https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}"

payload = {
    "automatedTaxesEnabled": {},
    "billingAddress": {},
    "billingCompanyId": {},
    "billingContactId": {},
    "billingStartDateOverride": {},
    "dealId": {},
    "externalPaymentMethodReferenceId": {},
    "locale": {},
    "name": {},
    "netPaymentTerms": {},
    "ownerId": {},
    "poNumber": {},
    "sellerCompanyAddress": {},
    "sellerCompanyDomain": {},
    "sellerCompanyName": {},
    "sellerEmail": {},
    "sellerFirstName": {},
    "sellerLastName": {},
    "sellerPhone": {},
    "addressTypesToCollect": [],
    "allowedPaymentMethods": [],
    "customProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    automatedTaxesEnabled: {},
    billingAddress: {},
    billingCompanyId: {},
    billingContactId: {},
    billingStartDateOverride: {},
    dealId: {},
    externalPaymentMethodReferenceId: {},
    locale: {},
    name: {},
    netPaymentTerms: {},
    ownerId: {},
    poNumber: {},
    sellerCompanyAddress: {},
    sellerCompanyDomain: {},
    sellerCompanyName: {},
    sellerEmail: {},
    sellerFirstName: {},
    sellerLastName: {},
    sellerPhone: {},
    addressTypesToCollect: [],
    allowedPaymentMethods: [],
    customProperties: {}
  })
};

fetch('https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}', 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/contracts/{contractId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'automatedTaxesEnabled' => [
        
    ],
    'billingAddress' => [
        
    ],
    'billingCompanyId' => [
        
    ],
    'billingContactId' => [
        
    ],
    'billingStartDateOverride' => [
        
    ],
    'dealId' => [
        
    ],
    'externalPaymentMethodReferenceId' => [
        
    ],
    'locale' => [
        
    ],
    'name' => [
        
    ],
    'netPaymentTerms' => [
        
    ],
    'ownerId' => [
        
    ],
    'poNumber' => [
        
    ],
    'sellerCompanyAddress' => [
        
    ],
    'sellerCompanyDomain' => [
        
    ],
    'sellerCompanyName' => [
        
    ],
    'sellerEmail' => [
        
    ],
    'sellerFirstName' => [
        
    ],
    'sellerLastName' => [
        
    ],
    'sellerPhone' => [
        
    ],
    'addressTypesToCollect' => [
        
    ],
    'allowedPaymentMethods' => [
        
    ],
    'customProperties' => [
        
    ]
  ]),
  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/contracts/{contractId}"

	payload := strings.NewReader("{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "addressTypesToCollect": [
    "BILLING_ADDRESS"
  ],
  "allowedPaymentMethods": [
    "CREDIT_OR_DEBIT_CARD"
  ],
  "automatedTaxesEnabled": true,
  "customProperties": {},
  "hubspotBillingEnabled": true,
  "id": "<string>",
  "lineItems": [
    {
      "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>"
    }
  ],
  "paymentEnabled": true,
  "status": "ACTIVE",
  "storePaymentMethodAtCheckout": true,
  "allTransactionsFeeName": "<string>",
  "allTransactionsFeePercentage": 123,
  "annualContractValue": 123,
  "billingAddress": {
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "billingCompanyId": "<string>",
  "billingContactId": "<string>",
  "billingStartDateOverride": "2023-12-25",
  "businessUnitId": "<string>",
  "cardFeeName": "<string>",
  "cardFeePercentage": 123,
  "collectionProcess": "AUTOMATIC_PAYMENTS",
  "contractEffectiveDate": "2023-12-25",
  "contractSourceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "currentAnnualRecurringRevenue": 123,
  "currentMonthlyRecurringRevenue": 123,
  "dealId": "<string>",
  "directDebitFeeName": "<string>",
  "directDebitFeePercentage": 123,
  "discountCode": "<string>",
  "endDate": "2023-12-25",
  "externalPaymentMethodReferenceId": "<string>",
  "language": "<string>",
  "locale": "<string>",
  "name": "<string>",
  "netPaymentTerms": 123,
  "paymentMethod": "<string>",
  "poNumber": "<string>",
  "preTerminationContractValue": 123,
  "renewalContractId": "<string>",
  "renewalDate": "2023-12-25",
  "sellerCompanyAddress": {
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "sellerCompanyName": "<string>",
  "sellerEmail": "<string>",
  "sellerFirstName": "<string>",
  "sellerLastName": "<string>",
  "sellerPhoneNumber": "<string>",
  "startDate": "2023-12-25",
  "terminationDate": "2023-12-25",
  "totalBilledAmount": 123,
  "totalBilledAmountPreTax": 123,
  "totalCollectedFees": 123,
  "totalCollectedTaxes": 123,
  "totalContractValue": 123,
  "totalPaidAmount": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
  }
}

PATCH

commerce

contracts

2027-03-beta

contracts

{contractId}

Atualizar contrato

curl --request PATCH \
  --url https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "automatedTaxesEnabled": {},
  "billingAddress": {},
  "billingCompanyId": {},
  "billingContactId": {},
  "billingStartDateOverride": {},
  "dealId": {},
  "externalPaymentMethodReferenceId": {},
  "locale": {},
  "name": {},
  "netPaymentTerms": {},
  "ownerId": {},
  "poNumber": {},
  "sellerCompanyAddress": {},
  "sellerCompanyDomain": {},
  "sellerCompanyName": {},
  "sellerEmail": {},
  "sellerFirstName": {},
  "sellerLastName": {},
  "sellerPhone": {},
  "addressTypesToCollect": [],
  "allowedPaymentMethods": [],
  "customProperties": {}
}
'

import requests

url = "https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}"

payload = {
    "automatedTaxesEnabled": {},
    "billingAddress": {},
    "billingCompanyId": {},
    "billingContactId": {},
    "billingStartDateOverride": {},
    "dealId": {},
    "externalPaymentMethodReferenceId": {},
    "locale": {},
    "name": {},
    "netPaymentTerms": {},
    "ownerId": {},
    "poNumber": {},
    "sellerCompanyAddress": {},
    "sellerCompanyDomain": {},
    "sellerCompanyName": {},
    "sellerEmail": {},
    "sellerFirstName": {},
    "sellerLastName": {},
    "sellerPhone": {},
    "addressTypesToCollect": [],
    "allowedPaymentMethods": [],
    "customProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    automatedTaxesEnabled: {},
    billingAddress: {},
    billingCompanyId: {},
    billingContactId: {},
    billingStartDateOverride: {},
    dealId: {},
    externalPaymentMethodReferenceId: {},
    locale: {},
    name: {},
    netPaymentTerms: {},
    ownerId: {},
    poNumber: {},
    sellerCompanyAddress: {},
    sellerCompanyDomain: {},
    sellerCompanyName: {},
    sellerEmail: {},
    sellerFirstName: {},
    sellerLastName: {},
    sellerPhone: {},
    addressTypesToCollect: [],
    allowedPaymentMethods: [],
    customProperties: {}
  })
};

fetch('https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}', 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/contracts/{contractId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'automatedTaxesEnabled' => [
        
    ],
    'billingAddress' => [
        
    ],
    'billingCompanyId' => [
        
    ],
    'billingContactId' => [
        
    ],
    'billingStartDateOverride' => [
        
    ],
    'dealId' => [
        
    ],
    'externalPaymentMethodReferenceId' => [
        
    ],
    'locale' => [
        
    ],
    'name' => [
        
    ],
    'netPaymentTerms' => [
        
    ],
    'ownerId' => [
        
    ],
    'poNumber' => [
        
    ],
    'sellerCompanyAddress' => [
        
    ],
    'sellerCompanyDomain' => [
        
    ],
    'sellerCompanyName' => [
        
    ],
    'sellerEmail' => [
        
    ],
    'sellerFirstName' => [
        
    ],
    'sellerLastName' => [
        
    ],
    'sellerPhone' => [
        
    ],
    'addressTypesToCollect' => [
        
    ],
    'allowedPaymentMethods' => [
        
    ],
    'customProperties' => [
        
    ]
  ]),
  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/contracts/{contractId}"

	payload := strings.NewReader("{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"automatedTaxesEnabled\": {},\n  \"billingAddress\": {},\n  \"billingCompanyId\": {},\n  \"billingContactId\": {},\n  \"billingStartDateOverride\": {},\n  \"dealId\": {},\n  \"externalPaymentMethodReferenceId\": {},\n  \"locale\": {},\n  \"name\": {},\n  \"netPaymentTerms\": {},\n  \"ownerId\": {},\n  \"poNumber\": {},\n  \"sellerCompanyAddress\": {},\n  \"sellerCompanyDomain\": {},\n  \"sellerCompanyName\": {},\n  \"sellerEmail\": {},\n  \"sellerFirstName\": {},\n  \"sellerLastName\": {},\n  \"sellerPhone\": {},\n  \"addressTypesToCollect\": [],\n  \"allowedPaymentMethods\": [],\n  \"customProperties\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "addressTypesToCollect": [
    "BILLING_ADDRESS"
  ],
  "allowedPaymentMethods": [
    "CREDIT_OR_DEBIT_CARD"
  ],
  "automatedTaxesEnabled": true,
  "customProperties": {},
  "hubspotBillingEnabled": true,
  "id": "<string>",
  "lineItems": [
    {
      "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>"
    }
  ],
  "paymentEnabled": true,
  "status": "ACTIVE",
  "storePaymentMethodAtCheckout": true,
  "allTransactionsFeeName": "<string>",
  "allTransactionsFeePercentage": 123,
  "annualContractValue": 123,
  "billingAddress": {
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "billingCompanyId": "<string>",
  "billingContactId": "<string>",
  "billingStartDateOverride": "2023-12-25",
  "businessUnitId": "<string>",
  "cardFeeName": "<string>",
  "cardFeePercentage": 123,
  "collectionProcess": "AUTOMATIC_PAYMENTS",
  "contractEffectiveDate": "2023-12-25",
  "contractSourceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "currentAnnualRecurringRevenue": 123,
  "currentMonthlyRecurringRevenue": 123,
  "dealId": "<string>",
  "directDebitFeeName": "<string>",
  "directDebitFeePercentage": 123,
  "discountCode": "<string>",
  "endDate": "2023-12-25",
  "externalPaymentMethodReferenceId": "<string>",
  "language": "<string>",
  "locale": "<string>",
  "name": "<string>",
  "netPaymentTerms": 123,
  "paymentMethod": "<string>",
  "poNumber": "<string>",
  "preTerminationContractValue": 123,
  "renewalContractId": "<string>",
  "renewalDate": "2023-12-25",
  "sellerCompanyAddress": {
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "sellerCompanyName": "<string>",
  "sellerEmail": "<string>",
  "sellerFirstName": "<string>",
  "sellerLastName": "<string>",
  "sellerPhoneNumber": "<string>",
  "startDate": "2023-12-25",
  "terminationDate": "2023-12-25",
  "totalBilledAmount": 123,
  "totalBilledAmountPreTax": 123,
  "totalCollectedFees": 123,
  "totalCollectedTaxes": 123,
  "totalContractValue": 123,
  "totalPaidAmount": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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

Required Scopes

Parâmetros de caminho

contractId

string

obrigatório

O identificador exclusivo do contrato a ser atualizado.

Corpo

application/json

automatedTaxesEnabled

object

obrigatório

Um objeto que indica se os impostos automatizados estão habilitados para o contrato.

billingAddress

object

obrigatório

Um objeto que representa o endereço de cobrança associado ao contrato.

billingCompanyId

object

obrigatório

Um objeto que representa o ID da empresa de cobrança associada ao contrato.

billingContactId

object

obrigatório

Um objeto que representa o ID do contato de cobrança associado ao contrato.

billingStartDateOverride

object

obrigatório

Um objeto que representa a substituição da data de início da cobrança.

dealId

object

obrigatório

Um objeto que representa o ID do negócio associado ao contrato.

externalPaymentMethodReferenceId

object

obrigatório

Um objeto que representa o ID de referência externa para o método de pagamento.

locale

object

obrigatório

Um objeto que representa as configurações de localidade para o contrato.

name

object

obrigatório

Um objeto que representa o nome do contrato.

netPaymentTerms

object

obrigatório

Um objeto que indica os termos de pagamento líquidos para o contrato.

ownerId

object

obrigatório

Um objeto que representa o ID do proprietário do contrato.

poNumber

object

obrigatório

Um objeto que representa o número do pedido de compra para o contrato.

sellerCompanyAddress

object

obrigatório

Um objeto que representa o endereço da empresa do vendedor.

sellerCompanyDomain

object

obrigatório

Um objeto que representa o domínio da empresa do vendedor.

sellerCompanyName

object

obrigatório

Um objeto que representa o nome da empresa do vendedor.

sellerEmail

object

obrigatório

Um objeto que representa o endereço de e-mail do vendedor.

sellerFirstName

object

obrigatório

Um objeto que representa o primeiro nome do vendedor.

sellerLastName

object

obrigatório

Um objeto que representa o sobrenome do vendedor.

sellerPhone

object

obrigatório

Um objeto que representa o número de telefone do vendedor.

addressTypesToCollect

enum<string>[]

Uma matriz de strings que indicam os tipos de endereços a serem coletados, como "BILLING_ADDRESS" ou "SHIPPING_ADDRESS".

Opções disponíveis:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

Uma matriz de strings que especifica os métodos de pagamento permitidos, que podem incluir "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA".

Opções disponíveis:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

customProperties

object

Um objeto que contém um mapa de nomes de propriedades personalizadas para seus valores, representados como strings.

Show child attributes

Resposta

successful operation

addressTypesToCollect

enum<string>[]

obrigatório

Uma matriz que indica os tipos de endereços a serem coletados. Os valores válidos incluem "BILLING_ADDRESS" e "SHIPPING_ADDRESS".

Opções disponíveis:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

obrigatório

Uma matriz de métodos de pagamento permitidos. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA".

Opções disponíveis:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

automatedTaxesEnabled

boolean

obrigatório

Indica se os impostos automatizados estão ativados para o contrato.

customProperties

object

obrigatório

Um mapa de nomes de propriedades personalizadas para seus valores.

Show child attributes

hubspotBillingEnabled

boolean

obrigatório

Indica se a cobrança da HubSpot está ativada para o contrato.

string

obrigatório

O identificador exclusivo do contrato.

lineItems

object[]

obrigatório

Uma lista de itens de linha incluídos no contrato.

Show child attributes

paymentEnabled

boolean

obrigatório

Indica se o pagamento está habilitado para o contrato.

status

enum<string>

obrigatório

O status atual do contrato. Os valores válidos incluem "DRAFT", "ACTIVE", "PAUSED", "COMPLETED" e "TERMINATED".

Opções disponíveis:

ACTIVE,

COMPLETED,

DRAFT,

PAUSED,

TERMINATED

storePaymentMethodAtCheckout

boolean

obrigatório

Indica se o método de pagamento deve ser armazenado no checkout.

allTransactionsFeeName

string

Nome da taxa aplicada a todas as transações.

allTransactionsFeePercentage

number

A porcentagem da taxa aplicada a todas as transações.

annualContractValue

number

O valor anual do contrato.

billingAddress

object

Show child attributes

billingCompanyId

string

O identificador exclusivo da empresa de cobrança associada ao contrato.

billingContactId

string

Identificador exclusivo do contato de cobrança associado ao contrato.

billingStartDateOverride

string<date>

A data para substituir a data de início da cobrança, no formato ISO 8601.

businessUnitId

string

O identificador exclusivo da unidade de negócio associada ao contrato.

cardFeeName

string

O nome da taxa aplicada às transações com cartão.

cardFeePercentage

number

A porcentagem da taxa aplicada a transações com cartão.

collectionProcess

enum<string>

O processo de cobrança de pagamentos. Os valores válidos incluem "MANUAL_PAYMENTS" e "AUTOMATIC_PAYMENTS".

Opções disponíveis:

AUTOMATIC_PAYMENTS,

MANUAL_PAYMENTS

contractEffectiveDate

string<date>

A data em que o contrato entra em vigor, no formato ISO 8601.

contractSourceId

string

O identificador exclusivo da origem do contrato.

createdAt

string<date-time>

A data e a hora em que o contrato foi criado, no formato ISO 8601.

currencyCode

string

O código da moeda associado ao contrato, representado como uma string.

currentAnnualRecurringRevenue

number

A receita recorrente anual atual do contrato.

currentMonthlyRecurringRevenue

number

A receita mensal recorrente atual do contrato.

dealId

string

O identificador exclusivo do negócio associado ao contrato.

directDebitFeeName

string

O nome da taxa aplicada a transações de débito direto.

directDebitFeePercentage

number

A porcentagem da taxa aplicada a transações de débito direto.

discountCode

string

O código de desconto aplicado ao contrato.

endDate

string<date>

A data de término do contrato, no formato ISO 8601.

externalPaymentMethodReferenceId

string

O ID de referência externa para o método de pagamento.

language

string

O idioma associado ao contrato.

locale

string

O local associado ao contrato.

name

string

O nome do contrato.

netPaymentTerms

integer<int32>

Os termos de pagamento líquidos do contrato, representados como um número inteiro.

paymentMethod

string

O método de pagamento usado no contrato.

poNumber

string

O número do pedido de compra associado ao contrato.

preTerminationContractValue

number

O valor do contrato antes da rescisão.

renewalContractId

string

O identificador exclusivo do contrato de renovação.

renewalDate

string<date>

A data em que o contrato será renovado, no formato ISO 8601.

sellerCompanyAddress

object

Show child attributes

sellerCompanyName

string

O nome da empresa do vendedor.

sellerEmail

string

O endereço de e-mail do vendedor.

sellerFirstName

string

O nome do vendedor.

sellerLastName

string

O sobrenome do vendedor.

sellerPhoneNumber

string

O número de telefone do vendedor.

startDate

string<date>

A data de início do contrato, no formato ISO 8601.

terminationDate

string<date>

A data de rescisão do contrato, no formato ISO 8601.

totalBilledAmount

number

O valor total faturado no contrato.

totalBilledAmountPreTax

number

O valor total faturado no contrato antes dos impostos.

totalCollectedFees

number

O valor total das taxas cobradas sob o contrato.

totalCollectedTaxes

number

O valor total dos impostos recolhidos sob o contrato.

totalContractValue

number

O valor total do contrato.

totalPaidAmount

number

O valor total pago no contrato.

updatedAt

string<date-time>

A data e a hora da última atualização do contrato, no formato ISO 8601.

Última modificação em 6 de outubro de 2026

Automação

CRM

Marketing

Reuniões

Consultando dados

Relatórios

Receita

Parâmetros de caminho

Corpo

Resposta