curl --request PATCH \
--url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId} \
--header 'Content-Type: application/json' \
--data '
{
"businessUnitId": {},
"dealConfigurations": {},
"descriptionHtml": {},
"discountObjectId": {},
"domainId": {},
"expirationSettings": {},
"successUrl": {},
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"automatedSalesTaxEnabled": true,
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"createContractOnPurchase": true,
"currencyCode": "<string>",
"discountCodeEnabled": true,
"enableDefaultCheckoutFees": true,
"feeObjectIds": [
"<string>"
],
"fees": [
{
"label": "<string>",
"value": 123
}
],
"includeEmailInSuccessRedirect": true,
"isOneTimeUseEnabled": true,
"lineItemObjectIds": [
"<string>"
],
"lineItems": [
{
"mode": "CUSTOM",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
]
},
"quantity": 123,
"allowBuyerSelectedQuantity": true,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
}
],
"paymentLinkName": "<string>",
"storePaymentMethodAtCheckout": true,
"taxObjectIds": [
"<string>"
],
"taxes": [
{
"label": "<string>",
"value": 123
}
]
}
'import requests
url = "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}"
payload = {
"businessUnitId": {},
"dealConfigurations": {},
"descriptionHtml": {},
"discountObjectId": {},
"domainId": {},
"expirationSettings": {},
"successUrl": {},
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": True,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"automatedSalesTaxEnabled": True,
"collectFullBillingAddress": True,
"collectShippingAddress": True,
"createContractOnPurchase": True,
"currencyCode": "<string>",
"discountCodeEnabled": True,
"enableDefaultCheckoutFees": True,
"feeObjectIds": ["<string>"],
"fees": [
{
"label": "<string>",
"value": 123
}
],
"includeEmailInSuccessRedirect": True,
"isOneTimeUseEnabled": True,
"lineItemObjectIds": ["<string>"],
"lineItems": [
{
"mode": "CUSTOM",
"name": "<string>",
"pricing": { "prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
] },
"quantity": 123,
"allowBuyerSelectedQuantity": True,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": True,
"isOptional": True,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
}
],
"paymentLinkName": "<string>",
"storePaymentMethodAtCheckout": True,
"taxObjectIds": ["<string>"],
"taxes": [
{
"label": "<string>",
"value": 123
}
]
}
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({
businessUnitId: {},
dealConfigurations: {},
descriptionHtml: {},
discountObjectId: {},
domainId: {},
expirationSettings: {},
successUrl: {},
acceptedPaymentMethods: [],
additionalFormFields: [
{
isRequired: true,
label: '<string>',
options: [{label: '<string>', value: '<string>', description: '<string>'}],
propertyName: '<string>',
description: '<string>'
}
],
automatedSalesTaxEnabled: true,
collectFullBillingAddress: true,
collectShippingAddress: true,
createContractOnPurchase: true,
currencyCode: '<string>',
discountCodeEnabled: true,
enableDefaultCheckoutFees: true,
feeObjectIds: ['<string>'],
fees: [{label: '<string>', value: 123}],
includeEmailInSuccessRedirect: true,
isOneTimeUseEnabled: true,
lineItemObjectIds: ['<string>'],
lineItems: [
{
mode: 'CUSTOM',
name: '<string>',
pricing: {prices: [{currencyCode: '<string>', price: {}, maxQuantity: 123}]},
quantity: 123,
allowBuyerSelectedQuantity: true,
billingCycleAnchorDate: '2023-12-25',
billingStartDelayDays: 123,
billingStartDelayMonths: 123,
buyerSelectedQuantityMax: 123,
buyerSelectedQuantityMin: 123,
description: '<string>',
discount: 123,
discountPercentage: 123,
externalId: '<string>',
images: '<string>',
isEditablePrice: true,
isOptional: true,
lineItemCurrencyCode: '<string>',
positionOnQuote: 123,
priceBookId: '<string>',
productId: '<string>',
productType: '<string>',
recurringBillingEndDate: '2023-12-25',
recurringBillingPeriod: '<string>',
recurringBillingStartDate: '2023-12-25',
richTextDescription: '<string>',
sku: '<string>',
taxCategory: '<string>',
taxRateGroupId: '<string>',
variantId: '<string>'
}
],
paymentLinkName: '<string>',
storePaymentMethodAtCheckout: true,
taxObjectIds: ['<string>'],
taxes: [{label: '<string>', value: 123}]
})
};
fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}', 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/payment-links/2026-09/payment-links/{paymentLinkId}",
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([
'businessUnitId' => [
],
'dealConfigurations' => [
],
'descriptionHtml' => [
],
'discountObjectId' => [
],
'domainId' => [
],
'expirationSettings' => [
],
'successUrl' => [
],
'acceptedPaymentMethods' => [
],
'additionalFormFields' => [
[
'isRequired' => true,
'label' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>',
'description' => '<string>'
]
],
'propertyName' => '<string>',
'description' => '<string>'
]
],
'automatedSalesTaxEnabled' => true,
'collectFullBillingAddress' => true,
'collectShippingAddress' => true,
'createContractOnPurchase' => true,
'currencyCode' => '<string>',
'discountCodeEnabled' => true,
'enableDefaultCheckoutFees' => true,
'feeObjectIds' => [
'<string>'
],
'fees' => [
[
'label' => '<string>',
'value' => 123
]
],
'includeEmailInSuccessRedirect' => true,
'isOneTimeUseEnabled' => true,
'lineItemObjectIds' => [
'<string>'
],
'lineItems' => [
[
'mode' => 'CUSTOM',
'name' => '<string>',
'pricing' => [
'prices' => [
[
'currencyCode' => '<string>',
'price' => [
],
'maxQuantity' => 123
]
]
],
'quantity' => 123,
'allowBuyerSelectedQuantity' => true,
'billingCycleAnchorDate' => '2023-12-25',
'billingStartDelayDays' => 123,
'billingStartDelayMonths' => 123,
'buyerSelectedQuantityMax' => 123,
'buyerSelectedQuantityMin' => 123,
'description' => '<string>',
'discount' => 123,
'discountPercentage' => 123,
'externalId' => '<string>',
'images' => '<string>',
'isEditablePrice' => true,
'isOptional' => true,
'lineItemCurrencyCode' => '<string>',
'positionOnQuote' => 123,
'priceBookId' => '<string>',
'productId' => '<string>',
'productType' => '<string>',
'recurringBillingEndDate' => '2023-12-25',
'recurringBillingPeriod' => '<string>',
'recurringBillingStartDate' => '2023-12-25',
'richTextDescription' => '<string>',
'sku' => '<string>',
'taxCategory' => '<string>',
'taxRateGroupId' => '<string>',
'variantId' => '<string>'
]
],
'paymentLinkName' => '<string>',
'storePaymentMethodAtCheckout' => true,
'taxObjectIds' => [
'<string>'
],
'taxes' => [
[
'label' => '<string>',
'value' => 123
]
]
]),
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/payment-links/2026-09/payment-links/{paymentLinkId}"
payload := strings.NewReader("{\n \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\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/payment-links/2026-09/payment-links/{paymentLinkId}")
.header("Content-Type", "application/json")
.body("{\n \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}")
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 \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"acceptedPaymentMethods": [
"CREDIT_OR_DEBIT_CARD"
],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"objectType": "COMPANY",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"archived": true,
"automatedSalesTaxEnabled": true,
"checkoutFeeIds": [
"<string>"
],
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"completedPurchaseCount": 123,
"createContractOnPurchase": true,
"currencyCode": "<string>",
"discountCodeEnabled": true,
"discounts": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"fees": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"formGuid": "<string>",
"id": "<string>",
"includeEmailInSuccessRedirect": true,
"isOneTimeUseEnabled": true,
"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>"
}
],
"paymentLinkName": "<string>",
"paymentLinkUrl": "<string>",
"state": "OFF",
"storePaymentMethodAtCheckout": true,
"taxes": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"archivedAt": "2023-11-07T05:31:56Z",
"businessUnitId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dealConfigurations": {
"createNewDealOnPurchase": true,
"pipelineStageId": "<string>"
},
"descriptionHtml": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"successUrl": "<string>",
"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"
}
}Update a payment link
Mettre à jour un lien de paiement par ID.
curl --request PATCH \
--url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId} \
--header 'Content-Type: application/json' \
--data '
{
"businessUnitId": {},
"dealConfigurations": {},
"descriptionHtml": {},
"discountObjectId": {},
"domainId": {},
"expirationSettings": {},
"successUrl": {},
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"automatedSalesTaxEnabled": true,
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"createContractOnPurchase": true,
"currencyCode": "<string>",
"discountCodeEnabled": true,
"enableDefaultCheckoutFees": true,
"feeObjectIds": [
"<string>"
],
"fees": [
{
"label": "<string>",
"value": 123
}
],
"includeEmailInSuccessRedirect": true,
"isOneTimeUseEnabled": true,
"lineItemObjectIds": [
"<string>"
],
"lineItems": [
{
"mode": "CUSTOM",
"name": "<string>",
"pricing": {
"prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
]
},
"quantity": 123,
"allowBuyerSelectedQuantity": true,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": true,
"isOptional": true,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
}
],
"paymentLinkName": "<string>",
"storePaymentMethodAtCheckout": true,
"taxObjectIds": [
"<string>"
],
"taxes": [
{
"label": "<string>",
"value": 123
}
]
}
'import requests
url = "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}"
payload = {
"businessUnitId": {},
"dealConfigurations": {},
"descriptionHtml": {},
"discountObjectId": {},
"domainId": {},
"expirationSettings": {},
"successUrl": {},
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": True,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"automatedSalesTaxEnabled": True,
"collectFullBillingAddress": True,
"collectShippingAddress": True,
"createContractOnPurchase": True,
"currencyCode": "<string>",
"discountCodeEnabled": True,
"enableDefaultCheckoutFees": True,
"feeObjectIds": ["<string>"],
"fees": [
{
"label": "<string>",
"value": 123
}
],
"includeEmailInSuccessRedirect": True,
"isOneTimeUseEnabled": True,
"lineItemObjectIds": ["<string>"],
"lineItems": [
{
"mode": "CUSTOM",
"name": "<string>",
"pricing": { "prices": [
{
"currencyCode": "<string>",
"price": {},
"maxQuantity": 123
}
] },
"quantity": 123,
"allowBuyerSelectedQuantity": True,
"billingCycleAnchorDate": "2023-12-25",
"billingStartDelayDays": 123,
"billingStartDelayMonths": 123,
"buyerSelectedQuantityMax": 123,
"buyerSelectedQuantityMin": 123,
"description": "<string>",
"discount": 123,
"discountPercentage": 123,
"externalId": "<string>",
"images": "<string>",
"isEditablePrice": True,
"isOptional": True,
"lineItemCurrencyCode": "<string>",
"positionOnQuote": 123,
"priceBookId": "<string>",
"productId": "<string>",
"productType": "<string>",
"recurringBillingEndDate": "2023-12-25",
"recurringBillingPeriod": "<string>",
"recurringBillingStartDate": "2023-12-25",
"richTextDescription": "<string>",
"sku": "<string>",
"taxCategory": "<string>",
"taxRateGroupId": "<string>",
"variantId": "<string>"
}
],
"paymentLinkName": "<string>",
"storePaymentMethodAtCheckout": True,
"taxObjectIds": ["<string>"],
"taxes": [
{
"label": "<string>",
"value": 123
}
]
}
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({
businessUnitId: {},
dealConfigurations: {},
descriptionHtml: {},
discountObjectId: {},
domainId: {},
expirationSettings: {},
successUrl: {},
acceptedPaymentMethods: [],
additionalFormFields: [
{
isRequired: true,
label: '<string>',
options: [{label: '<string>', value: '<string>', description: '<string>'}],
propertyName: '<string>',
description: '<string>'
}
],
automatedSalesTaxEnabled: true,
collectFullBillingAddress: true,
collectShippingAddress: true,
createContractOnPurchase: true,
currencyCode: '<string>',
discountCodeEnabled: true,
enableDefaultCheckoutFees: true,
feeObjectIds: ['<string>'],
fees: [{label: '<string>', value: 123}],
includeEmailInSuccessRedirect: true,
isOneTimeUseEnabled: true,
lineItemObjectIds: ['<string>'],
lineItems: [
{
mode: 'CUSTOM',
name: '<string>',
pricing: {prices: [{currencyCode: '<string>', price: {}, maxQuantity: 123}]},
quantity: 123,
allowBuyerSelectedQuantity: true,
billingCycleAnchorDate: '2023-12-25',
billingStartDelayDays: 123,
billingStartDelayMonths: 123,
buyerSelectedQuantityMax: 123,
buyerSelectedQuantityMin: 123,
description: '<string>',
discount: 123,
discountPercentage: 123,
externalId: '<string>',
images: '<string>',
isEditablePrice: true,
isOptional: true,
lineItemCurrencyCode: '<string>',
positionOnQuote: 123,
priceBookId: '<string>',
productId: '<string>',
productType: '<string>',
recurringBillingEndDate: '2023-12-25',
recurringBillingPeriod: '<string>',
recurringBillingStartDate: '2023-12-25',
richTextDescription: '<string>',
sku: '<string>',
taxCategory: '<string>',
taxRateGroupId: '<string>',
variantId: '<string>'
}
],
paymentLinkName: '<string>',
storePaymentMethodAtCheckout: true,
taxObjectIds: ['<string>'],
taxes: [{label: '<string>', value: 123}]
})
};
fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}', 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/payment-links/2026-09/payment-links/{paymentLinkId}",
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([
'businessUnitId' => [
],
'dealConfigurations' => [
],
'descriptionHtml' => [
],
'discountObjectId' => [
],
'domainId' => [
],
'expirationSettings' => [
],
'successUrl' => [
],
'acceptedPaymentMethods' => [
],
'additionalFormFields' => [
[
'isRequired' => true,
'label' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>',
'description' => '<string>'
]
],
'propertyName' => '<string>',
'description' => '<string>'
]
],
'automatedSalesTaxEnabled' => true,
'collectFullBillingAddress' => true,
'collectShippingAddress' => true,
'createContractOnPurchase' => true,
'currencyCode' => '<string>',
'discountCodeEnabled' => true,
'enableDefaultCheckoutFees' => true,
'feeObjectIds' => [
'<string>'
],
'fees' => [
[
'label' => '<string>',
'value' => 123
]
],
'includeEmailInSuccessRedirect' => true,
'isOneTimeUseEnabled' => true,
'lineItemObjectIds' => [
'<string>'
],
'lineItems' => [
[
'mode' => 'CUSTOM',
'name' => '<string>',
'pricing' => [
'prices' => [
[
'currencyCode' => '<string>',
'price' => [
],
'maxQuantity' => 123
]
]
],
'quantity' => 123,
'allowBuyerSelectedQuantity' => true,
'billingCycleAnchorDate' => '2023-12-25',
'billingStartDelayDays' => 123,
'billingStartDelayMonths' => 123,
'buyerSelectedQuantityMax' => 123,
'buyerSelectedQuantityMin' => 123,
'description' => '<string>',
'discount' => 123,
'discountPercentage' => 123,
'externalId' => '<string>',
'images' => '<string>',
'isEditablePrice' => true,
'isOptional' => true,
'lineItemCurrencyCode' => '<string>',
'positionOnQuote' => 123,
'priceBookId' => '<string>',
'productId' => '<string>',
'productType' => '<string>',
'recurringBillingEndDate' => '2023-12-25',
'recurringBillingPeriod' => '<string>',
'recurringBillingStartDate' => '2023-12-25',
'richTextDescription' => '<string>',
'sku' => '<string>',
'taxCategory' => '<string>',
'taxRateGroupId' => '<string>',
'variantId' => '<string>'
]
],
'paymentLinkName' => '<string>',
'storePaymentMethodAtCheckout' => true,
'taxObjectIds' => [
'<string>'
],
'taxes' => [
[
'label' => '<string>',
'value' => 123
]
]
]),
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/payment-links/2026-09/payment-links/{paymentLinkId}"
payload := strings.NewReader("{\n \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\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/payment-links/2026-09/payment-links/{paymentLinkId}")
.header("Content-Type", "application/json")
.body("{\n \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}")
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 \"businessUnitId\": {},\n \"dealConfigurations\": {},\n \"descriptionHtml\": {},\n \"discountObjectId\": {},\n \"domainId\": {},\n \"expirationSettings\": {},\n \"successUrl\": {},\n \"acceptedPaymentMethods\": [],\n \"additionalFormFields\": [\n {\n \"isRequired\": true,\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"propertyName\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"currencyCode\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"enableDefaultCheckoutFees\": true,\n \"feeObjectIds\": [\n \"<string>\"\n ],\n \"fees\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"includeEmailInSuccessRedirect\": true,\n \"isOneTimeUseEnabled\": true,\n \"lineItemObjectIds\": [\n \"<string>\"\n ],\n \"lineItems\": [\n {\n \"mode\": \"CUSTOM\",\n \"name\": \"<string>\",\n \"pricing\": {\n \"prices\": [\n {\n \"currencyCode\": \"<string>\",\n \"price\": {},\n \"maxQuantity\": 123\n }\n ]\n },\n \"quantity\": 123,\n \"allowBuyerSelectedQuantity\": true,\n \"billingCycleAnchorDate\": \"2023-12-25\",\n \"billingStartDelayDays\": 123,\n \"billingStartDelayMonths\": 123,\n \"buyerSelectedQuantityMax\": 123,\n \"buyerSelectedQuantityMin\": 123,\n \"description\": \"<string>\",\n \"discount\": 123,\n \"discountPercentage\": 123,\n \"externalId\": \"<string>\",\n \"images\": \"<string>\",\n \"isEditablePrice\": true,\n \"isOptional\": true,\n \"lineItemCurrencyCode\": \"<string>\",\n \"positionOnQuote\": 123,\n \"priceBookId\": \"<string>\",\n \"productId\": \"<string>\",\n \"productType\": \"<string>\",\n \"recurringBillingEndDate\": \"2023-12-25\",\n \"recurringBillingPeriod\": \"<string>\",\n \"recurringBillingStartDate\": \"2023-12-25\",\n \"richTextDescription\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxCategory\": \"<string>\",\n \"taxRateGroupId\": \"<string>\",\n \"variantId\": \"<string>\"\n }\n ],\n \"paymentLinkName\": \"<string>\",\n \"storePaymentMethodAtCheckout\": true,\n \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"acceptedPaymentMethods": [
"CREDIT_OR_DEBIT_CARD"
],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"objectType": "COMPANY",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"archived": true,
"automatedSalesTaxEnabled": true,
"checkoutFeeIds": [
"<string>"
],
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"completedPurchaseCount": 123,
"createContractOnPurchase": true,
"currencyCode": "<string>",
"discountCodeEnabled": true,
"discounts": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"fees": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"formGuid": "<string>",
"id": "<string>",
"includeEmailInSuccessRedirect": true,
"isOneTimeUseEnabled": true,
"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>"
}
],
"paymentLinkName": "<string>",
"paymentLinkUrl": "<string>",
"state": "OFF",
"storePaymentMethodAtCheckout": true,
"taxes": [
{
"id": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"label": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"value": 123,
"valueType": "FIXED"
}
],
"archivedAt": "2023-11-07T05:31:56Z",
"businessUnitId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dealConfigurations": {
"createNewDealOnPurchase": true,
"pipelineStageId": "<string>"
},
"descriptionHtml": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"successUrl": "<string>",
"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
Supported products
Required Scopes
Required Scopes
Paramètres de chemin
L'identifiant unique du lien de paiement à mettre à jour.
Corps
Objet représentant l'identifiant de l'unité commerciale associée au lien de paiement.
Un objet contenant les paramètres de configuration de la transaction.
Un objet contenant la description HTML du lien de paiement.
Un objet représentant l'ID de l'objet de réduction associé au lien de paiement.
Un objet représentant l'ID de domaine associé au lien de paiement.
Un objet représentant les paramètres d'expiration du lien de paiement.
Un objet représentant l'URL de succès vers laquelle l'utilisateur est redirigé après une transaction réussie.
Un tableau de chaînes de caractères indiquant les méthodes de paiement acceptées. Les valeurs valides incluent « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS » et « PADS ».
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Un tableau d'objets PaymentLinkFormField représentant des champs de formulaire supplémentaires pour le lien de paiement.
Show child attributes
Show child attributes
Un booléen indiquant si la taxe de vente automatisée est activée.
Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement.
Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement.
Un booléen indiquant si un contrat doit être créé lors de l'achat.
Le code de devise du lien de paiement, représenté sous forme de chaîne.
Show child attributes
Show child attributes
Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.
Un booléen indiquant si les frais de paiement par défaut sont activés.
Un tableau de chaînes de caractères représentant les identifiants des objets de frais associés au lien de paiement.
Un tableau d'objets FeeRequest représentant les frais associés au lien de paiement.
Show child attributes
Show child attributes
Un booléen indiquant s'il faut inclure l'email dans la redirection en cas de succès.
Un booléen indiquant si le lien de paiement est activé pour une utilisation unique.
Un tableau de chaînes de caractères représentant les identifiants des objets de ligne de produit associés au lien de paiement.
Un tableau d'objets de lignes de produit, qui peuvent être de type LineItemCustomCreateRequest, LineItemFromProductCreateRequest ou LineItemCloneCreateRequest.
- CUSTOM
- FROM_PRODUCT
- CLONE
Show child attributes
Show child attributes
Le nom du lien de paiement, représenté sous forme de chaîne de caractères.
L'état du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».
OFF, ON Un booléen indiquant si le mode de paiement doit être enregistré lors du paiement.
Un tableau de chaînes de caractères représentant les identifiants des objets fiscaux associés au lien de paiement.
Un tableau d'objets TaxRequest représentant les taxes associées au lien de paiement.
Show child attributes
Show child attributes
Réponse
successful operation
Un ensemble de méthodes de paiement acceptées pour le lien de paiement. Les valeurs valides incluent : « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS » et « PADS ».
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Un ensemble de champs de formulaire supplémentaires inclus dans le lien de paiement.
Show child attributes
Show child attributes
Un booléen indiquant si le lien de paiement est archivé.
Un booléen indiquant si la taxe de vente automatisée est activée pour le lien de paiement.
Un tableau d'ID de frais associés au lien de paiement.
Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement.
Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement.
Le nombre d'achats effectués via ce lien de paiement.
Un booléen indiquant si un contrat doit être créé lors de l'achat.
Le code de devise du lien de paiement, représenté sous forme de chaîne.
Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.
Un tableau d'objets en réduction associés au lien de paiement.
Show child attributes
Show child attributes
Un tableau d'objets de frais associés au lien de paiement.
Show child attributes
Show child attributes
Le GUID du formulaire associé au lien de paiement, représenté sous forme de chaîne de caractères.
L'identifiant unique du lien de paiement, représenté sous forme de chaîne de caractères.
Un booléen indiquant s'il faut inclure l'e-mail dans l'URL de redirection en cas de succès.
Un booléen indiquant si le lien de paiement est activé pour une utilisation unique.
Un tableau de lignes de produit associées au lien de paiement.
Show child attributes
Show child attributes
Le nom du lien de paiement, représenté sous forme de chaîne de caractères.
L'URL du lien de paiement, représentée sous forme de chaîne de caractères.
L'état actuel du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».
OFF, ON Un booléen indiquant s'il faut enregistrer le mode de paiement au moment du règlement.
Un tableau d'objets fiscaux associés au lien de paiement.
Show child attributes
Show child attributes
La date et l'heure d'archivage du lien de paiement, au format ISO 8601.
L'ID de l'unité commerciale associée au lien de paiement, représenté sous forme de chaîne de caractères.
La date et l'heure de création du lien de paiement, au format ISO 8601.
Show child attributes
Show child attributes
La description HTML du lien de paiement, représentée sous forme de chaîne.
L'ID de domaine associé au lien de paiement, représenté sous forme de chaîne de caractères.
Show child attributes
Show child attributes
L'URL de redirection en cas de paiement réussi, représentée sous forme de chaîne de caractères.
La date et l'heure de la dernière mise à jour du lien de paiement, au format ISO 8601.