Update contract

Actualizar contrato

curl --request PATCH \
  --url https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId} \
  --header 'Authorization: Bearer <token>' \
  --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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', '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 => [
    "Authorization: Bearer <token>",
    "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("Authorization", "Bearer <token>")
	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("Authorization", "Bearer <token>")
  .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["Authorization"] = 'Bearer <token>'
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}

Actualizar contrato

curl --request PATCH \
  --url https://api.hubapi.com/commerce/contracts/2027-03-beta/contracts/{contractId} \
  --header 'Authorization: Bearer <token>' \
  --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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', '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 => [
    "Authorization: Bearer <token>",
    "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("Authorization", "Bearer <token>")
	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("Authorization", "Bearer <token>")
  .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["Authorization"] = 'Bearer <token>'
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

Autorizaciones

Authorization

string

header

requerido

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code

Authorization URL: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token

Scopes1

revenue-contracts-public-api-write

Parámetros de ruta

contractId

string

requerido

Cuerpo

application/json

automatedTaxesEnabled

object

requerido

Un objeto que indica si los impuestos automatizados están habilitados en el contrato.

billingAddress

object

requerido

Un objeto que representa la dirección de facturación del contrato.

billingCompanyId

object

requerido

Un objeto que representa el ID de la empresa de facturación asociada al contrato.

billingContactId

object

requerido

Un objeto que representa el ID del contacto de facturación asociado al contrato.

billingStartDateOverride

object

requerido

Un objeto que representa una anulación para la fecha de inicio de facturación.

dealId

object

requerido

Un objeto que representa el ID del negocio asociado al contrato.

externalPaymentMethodReferenceId

object

requerido

Un objeto que representa un ID de referencia externa del método de pago.

locale

object

requerido

Un objeto que representa la configuración regional del contrato.

name

object

requerido

Un objeto que representa el nombre del contrato.

netPaymentTerms

object

requerido

Un objeto que representa las condiciones de pago netas del contrato.

ownerId

object

requerido

Un objeto que representa el ID del propietario del contrato.

poNumber

object

requerido

Un objeto que representa el número de orden de compra del contrato.

sellerCompanyAddress

object

requerido

Un objeto que representa la dirección de la empresa del vendedor.

sellerCompanyDomain

object

requerido

Un objeto que representa el dominio de la empresa del vendedor.

sellerCompanyName

object

requerido

Un objeto que representa el nombre de la empresa del vendedor.

sellerEmail

object

requerido

Un objeto que representa la dirección de correo electrónico del vendedor.

sellerFirstName

object

requerido

Un objeto que representa el nombre del vendedor.

sellerLastName

object

requerido

Un objeto que representa el apellido del vendedor.

sellerPhone

object

requerido

Un objeto que representa el número de teléfono del vendedor.

addressTypesToCollect

enum<string>[]

Una matriz que especifica los tipos de direcciones a recopilar, con valores válidos que incluyen "BILLING_ADDRESS" y "SHIPPING_ADDRESS".

Opciones disponibles:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

Un conjunto que especifica los métodos de pago permitidos, con valores válidos que incluyen "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" y "PADS".

Opciones disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

customProperties

object

Un objeto que contiene propiedades personalizadas, representadas como un mapa de nombres de propiedades a sus valores.

Show child attributes

Respuesta

successful operation

addressTypesToCollect

enum<string>[]

requerido

Un conjunto que indica los tipos de direcciones que se recogerán. Los valores válidos son "BILLING_ADDRESS" y "SHIPPING_ADDRESS".

Opciones disponibles:

BILLING_ADDRESS,

SHIPPING_ADDRESS

allowedPaymentMethods

enum<string>[]

requerido

Un conjunto de métodos de pago permitidos para el contrato. Los valores válidos son "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" y "PADS".

Opciones disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

automatedTaxesEnabled

boolean

requerido

Indica si los impuestos automatizados están habilitados para el contrato.

customProperties

object

requerido

Un mapa de nombres de propiedades personalizadas y sus valores para el contrato.

Show child attributes

hubspotBillingEnabled

boolean

requerido

Indica si la facturación de HubSpot está habilitada para el contrato.

string

requerido

El identificador único del contrato.

lineItems

object[]

requerido

Una lista de elementos de pedido incluidos en el contrato.

Show child attributes

paymentEnabled

boolean

requerido

Indica si el pago está habilitado para el contrato.

status

enum<string>

requerido

El estado actual del contrato. Los valores válidos son "DRAFT", "ACTIVE", "PAUSED", "COMPLETED" y "TERMINATED".

Opciones disponibles:

ACTIVE,

COMPLETED,

DRAFT,

PAUSED,

TERMINATED

storePaymentMethodAtCheckout

boolean

requerido

Indica si el método de pago se debe guardar al finalizar el pago.

allTransactionsFeeName

string

El nombre de la tarifa aplicada a todas las transacciones.

allTransactionsFeePercentage

number

El porcentaje de la tarifa aplicada a todas las transacciones.

annualContractValue

number

El valor anual del contrato, representado como un número.

billingAddress

object

Show child attributes

billingCompanyId

string

El identificador único de la empresa de facturación asociada al contrato.

billingContactId

string

El identificador único del contacto de facturación asociado al contrato.

billingStartDateOverride

string<date>

Una anulación para la fecha de inicio de facturación, en formato AAAA-MM-DD.

businessUnitId

string

El ID de la unidad de negocio (marca) que se asociará a este contrato. Cuando se establece, las cotizaciones y facturas creadas a partir del contrato heredan el kit de marca correspondiente.

cardFeeName

string

El nombre de la tarifa aplicada a las transacciones con tarjeta.

cardFeePercentage

number

El porcentaje de la tarifa aplicada a las transacciones con tarjeta.

collectionProcess

enum<string>

El proceso para hacer cobros. Los valores válidos son "MANUAL_PAYMENTS" y "AUTOMATIC_PAYMENTS".

Opciones disponibles:

AUTOMATIC_PAYMENTS,

MANUAL_PAYMENTS

contractEffectiveDate

string<date>

La fecha de entrada en vigor del contrato, en formato AAAA-MM-DD.

contractSourceId

string

El identificador único de la fuente del contrato.

createdAt

string<date-time>

La fecha y hora en que se creó el contrato, en formato ISO 8601.

currencyCode

string

El código de divisa utilizado para el contrato, representado como una cadena.

currentAnnualRecurringRevenue

number

Los ingresos recurrentes anuales actuales del contrato, representados como un número.

currentMonthlyRecurringRevenue

number

Los ingresos recurrentes mensuales actuales del contrato, representados como un número.

dealId

string

El identificador único del negocio asociado al contrato.

directDebitFeeName

string

El nombre de la tarifa aplicada a las transacciones de débito directo.

directDebitFeePercentage

number

El porcentaje de la tarifa aplicada a las transacciones de débito directo.

discountCode

string

El código de descuento aplicado al contrato.

endDate

string<date>

La fecha de finalización del contrato, en formato AAAA-MM-DD.

externalPaymentMethodReferenceId

string

El ID de referencia externo para el método de pago usado en el contrato.

language

string

El idioma usado en el contrato.

locale

string

La configuración regional del contrato.

name

string

El nombre del contrato.

netPaymentTerms

integer<int32>

Las condiciones de pago netas del contrato, representadas como un número entero.

paymentMethod

string

El método de pago usado en el contrato.

poNumber

string

El número de orden de compra asociado al contrato.

preTerminationContractValue

number

El valor del contrato antes de la rescisión, representado como un número.

renewalContractId

string

El identificador único del contrato de renovación.

renewalDate

string<date>

La fecha de renovación del contrato, en formato AAAA-MM-DD.

sellerCompanyAddress

object

Show child attributes

sellerCompanyName

string

El nombre de la empresa del vendedor.

sellerEmail

string

La dirección de correo electrónico del vendedor.

sellerFirstName

string

El nombre del vendedor.

sellerLastName

string

El apellido del vendedor.

sellerPhoneNumber

string

El número de teléfono del vendedor.

startDate

string<date>

La fecha de inicio del contrato, en formato AAAA-MM-DD.

terminationDate

string<date>

La fecha de rescisión del contrato, en formato AAAA-MM-DD.

totalBilledAmount

number

El importe total facturado en virtud del contrato, representado como un número.

totalBilledAmountPreTax

number

El importe total facturado en el contrato antes de impuestos, representado como un número.

totalCollectedFees

number

El total de tarifas cobradas en virtud del contrato, representado como un número.

totalCollectedTaxes

number

El total de impuestos recaudados bajo el contrato, representado como un número.

totalContractValue

number

El valor total del contrato, representado como un número.

totalPaidAmount

number

El importe total del pago en virtud del contrato, representado como un número.

updatedAt

string<date-time>

La fecha y hora de la última actualización del contrato, en formato ISO 8601.

Última modificación el 6 de octubre de 2026

Automatización

CRM

Marketing

Reuniones

Consultar datos

Crear informes

Ingresos

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta