Update contract

Mettre à jour le contrat

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}

Mettre à jour le contrat

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

Paramètres de chemin

contractId

string

requis

L'identifiant unique du contrat à mettre à jour.

Corps

application/json

automatedTaxesEnabled

object

requis

Un objet indiquant si les taxes automatisées sont activées pour le contrat.

billingAddress

object

requis

Un objet représentant l'adresse de facturation du contrat.

billingCompanyId

object

requis

Un objet représentant l'ID de l'entreprise de facturation associée au contrat.

billingContactId

object

requis

Un objet représentant l'ID du contact de facturation associé au contrat.

billingStartDateOverride

object

requis

Un objet représentant la dérogation pour la date de début de facturation.

dealId

object

requis

Un objet représentant l'ID de la transaction associée au contrat.

externalPaymentMethodReferenceId

object

requis

Un objet représentant l'ID de référence externe pour le mode de paiement.

locale

object

requis

Un objet représentant les paramètres régionaux du contrat.

name

object

requis

Un objet représentant le nom du contrat.

netPaymentTerms

object

requis

Un objet représentant les conditions de paiement nettes du contrat.

ownerId

object

requis

Un objet représentant l'ID du propriétaire du contrat.

poNumber

object

requis

Un objet représentant le numéro de bon de commande pour le contrat.

sellerCompanyAddress

object

requis

Un objet représentant l'adresse de l'entreprise du vendeur.

sellerCompanyDomain

object

requis

Un objet représentant le domaine de l'entreprise du vendeur.

sellerCompanyName

object

requis

Un objet représentant le nom de l'entreprise du vendeur.

sellerEmail

object

requis

Un objet représentant l'adresse e-mail du vendeur.

sellerFirstName

object

requis

Un objet représentant le prénom du vendeur.

sellerLastName

object

requis

Un objet représentant le nom de famille du vendeur.

sellerPhone

object

requis

Un objet représentant le numéro de téléphone du vendeur.

addressTypesToCollect

enum<string>[]

Un tableau de chaînes de caractères indiquant les types d'adresses à collecter, telles que « BILLING_ADDRESS » ou « SHIPPING_ADDRESS ».

Options disponibles:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

Un tableau de chaînes spécifiant les méthodes de paiement autorisées, qui peuvent inclure « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS », « PADS », « AFFIRM » et « KLARNA ».

Options disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

customProperties

object

Un objet contenant une carte des noms de propriétés personnalisées et de leurs valeurs, représentées sous forme de chaînes de caractères.

Show child attributes

Réponse

successful operation

addressTypesToCollect

enum<string>[]

requis

Un tableau indiquant les types d'adresses à collecter. Les valeurs valides incluent « BILLING_ADDRESS » et « SHIPPING_ADDRESS ».

Options disponibles:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

requis

Un tableau des méthodes de paiement autorisées. Les valeurs valides incluent « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS », « PADS », « AFFIRM » et « KLARNA ».

Options disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

automatedTaxesEnabled

boolean

requis

Indique si les taxes automatisées sont activées pour le contrat.

customProperties

object

requis

Une carte des noms de propriétés personnalisées et de leurs valeurs.

Show child attributes

hubspotBillingEnabled

boolean

requis

Indique si la facturation HubSpot est activée pour le contrat.

string

requis

L'identifiant unique du contrat.

lineItems

object[]

requis

Un ensemble de lignes de produit incluses dans le contrat.

Show child attributes

paymentEnabled

boolean

requis

Indique si le paiement est activé pour le contrat.

status

enum<string>

requis

Le statut actuel du contrat. Les valeurs valides incluent « BROUILLON », « ACTIF », « EN PAUSE », « TERMINÉ » et « RÉSILIÉ ».

Options disponibles:

ACTIVE,

COMPLETED,

DRAFT,

PAUSED,

TERMINATED

storePaymentMethodAtCheckout

boolean

requis

Indique si le mode de paiement doit être enregistré lors du paiement.

allTransactionsFeeName

string

Le nom des frais appliqués à toutes les transactions.

allTransactionsFeePercentage

number

Le pourcentage des frais appliqués à toutes les transactions.

annualContractValue

number

La valeur annuelle du contrat.

billingAddress

object

Show child attributes

billingCompanyId

string

L'identifiant unique de l'entreprise de facturation associée au contrat.

billingContactId

string

L'identifiant unique du contact de facturation associé au contrat.

billingStartDateOverride

string<date>

La date de remplacement de la date de début de facturation, au format ISO 8601.

businessUnitId

string

L'identifiant unique de l'unité commerciale associée au contrat.

cardFeeName

string

Nom des frais appliqués aux transactions par carte.

cardFeePercentage

number

Le pourcentage des frais appliqués aux transactions par carte.

collectionProcess

enum<string>

Le processus de collecte des paiements. Les valeurs valides incluent « MANUAL_PAYMENTS » et « AUTOMATIC_PAYMENTS ».

Options disponibles:

AUTOMATIC_PAYMENTS,

MANUAL_PAYMENTS

contractEffectiveDate

string<date>

La date d'entrée en vigueur du contrat, au format ISO 8601.

contractSourceId

string

L'identifiant unique de la source du contrat.

createdAt

string<date-time>

La date et l'heure de création du contrat, au format ISO 8601.

currencyCode

string

Le code de devise associé au contrat, représenté sous forme de chaîne.

currentAnnualRecurringRevenue

number

Le revenu annuel récurrent actuel pour le contrat.

currentMonthlyRecurringRevenue

number

Le revenu récurrent mensuel actuel du contrat.

dealId

string

L'identifiant unique de la transaction associée au contrat.

directDebitFeeName

string

Le nom des frais appliqués aux transactions par prélèvement automatique.

directDebitFeePercentage

number

Le pourcentage des frais appliqués aux transactions par prélèvement automatique.

discountCode

string

Le code de réduction appliqué au contrat.

endDate

string<date>

La date de fin du contrat, au format ISO 8601.

externalPaymentMethodReferenceId

string

L'ID de référence externe pour le mode de paiement.

language

string

La langue associée au contrat.

locale

string

Les paramètres régionaux associés au contrat.

name

string

Le nom du contrat.

netPaymentTerms

integer<int32>

Les conditions de paiement nettes du contrat, représentées par un entier.

paymentMethod

string

La méthode de paiement utilisée pour le contrat.

poNumber

string

Le numéro de bon de commande associé au contrat.

preTerminationContractValue

number

La valeur du contrat avant résiliation.

renewalContractId

string

L'identifiant unique du contrat de renouvellement.

renewalDate

string<date>

La date de renouvellement du contrat, au format ISO 8601.

sellerCompanyAddress

object

Show child attributes

sellerCompanyName

string

Le nom de l'entreprise du vendeur.

sellerEmail

string

L'adresse e-mail du vendeur.

sellerFirstName

string

Le prénom du vendeur.

sellerLastName

string

Le nom de famille du vendeur.

sellerPhoneNumber

string

Le numéro de téléphone du vendeur.

startDate

string<date>

La date de début du contrat, au format ISO 8601.

terminationDate

string<date>

La date de résiliation du contrat, au format ISO 8601.

totalBilledAmount

number

Le montant total facturé dans le cadre du contrat.

totalBilledAmountPreTax

number

Le montant total facturé dans le cadre du contrat avant impôts.

totalCollectedFees

number

Le montant total des frais perçus dans le cadre du contrat.

totalCollectedTaxes

number

Le montant total des taxes collectées dans le cadre du contrat.

totalContractValue

number

La valeur totale du contrat.

totalPaidAmount

number

Le montant total payé au titre du contrat.

updatedAt

string<date-time>

La date et l'heure de la dernière mise à jour du contrat, au format ISO 8601.

Dernière modification le 6 octobre 2026

Automatisation

CRM

Marketing

Rendez-vous

Interrogation de données

Reporting

Chiffre d'affaires

Paramètres de chemin

Corps

Réponse