Créer un lien de paiement
curl --request POST \
--url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links \
--header 'Content-Type: application/json' \
--data '
{
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"currencyCode": "<string>",
"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>",
"taxObjectIds": [
"<string>"
],
"taxes": [
{
"label": "<string>",
"value": 123
}
],
"automatedSalesTaxEnabled": true,
"businessUnitId": "<string>",
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"createContractOnPurchase": true,
"descriptionHtml": "<string>",
"discountCodeEnabled": true,
"discountObjectId": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"storePaymentMethodAtCheckout": true,
"successUrl": "<string>"
}
'import requests
url = "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links"
payload = {
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": True,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"currencyCode": "<string>",
"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>",
"taxObjectIds": ["<string>"],
"taxes": [
{
"label": "<string>",
"value": 123
}
],
"automatedSalesTaxEnabled": True,
"businessUnitId": "<string>",
"collectFullBillingAddress": True,
"collectShippingAddress": True,
"createContractOnPurchase": True,
"descriptionHtml": "<string>",
"discountCodeEnabled": True,
"discountObjectId": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"storePaymentMethodAtCheckout": True,
"successUrl": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
acceptedPaymentMethods: [],
additionalFormFields: [
{
isRequired: true,
label: '<string>',
options: [{label: '<string>', value: '<string>', description: '<string>'}],
propertyName: '<string>',
description: '<string>'
}
],
currencyCode: '<string>',
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>',
taxObjectIds: ['<string>'],
taxes: [{label: '<string>', value: 123}],
automatedSalesTaxEnabled: true,
businessUnitId: '<string>',
collectFullBillingAddress: true,
collectShippingAddress: true,
createContractOnPurchase: true,
descriptionHtml: '<string>',
discountCodeEnabled: true,
discountObjectId: '<string>',
domainId: '<string>',
expirationSettings: {expirationDate: '2023-11-07T05:31:56Z', maxPurchases: 123},
storePaymentMethodAtCheckout: true,
successUrl: '<string>'
})
};
fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'acceptedPaymentMethods' => [
],
'additionalFormFields' => [
[
'isRequired' => true,
'label' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>',
'description' => '<string>'
]
],
'propertyName' => '<string>',
'description' => '<string>'
]
],
'currencyCode' => '<string>',
'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>',
'taxObjectIds' => [
'<string>'
],
'taxes' => [
[
'label' => '<string>',
'value' => 123
]
],
'automatedSalesTaxEnabled' => true,
'businessUnitId' => '<string>',
'collectFullBillingAddress' => true,
'collectShippingAddress' => true,
'createContractOnPurchase' => true,
'descriptionHtml' => '<string>',
'discountCodeEnabled' => true,
'discountObjectId' => '<string>',
'domainId' => '<string>',
'expirationSettings' => [
'expirationDate' => '2023-11-07T05:31:56Z',
'maxPurchases' => 123
],
'storePaymentMethodAtCheckout' => true,
'successUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links"
payload := strings.NewReader("{\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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links")
.header("Content-Type", "application/json")
.body("{\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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\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"
}
}Liens de paiement
Create a payment link
Créez un nouveau lien de paiement dans votre compte HubSpot. Ce point de terminaison vous permet de spécifier divers attributs pour le lien de paiement, tels que les modes de paiement acceptés, la devise et les champs de formulaire supplémentaires. Le lien de paiement peut être configuré pour une utilisation unique et peut également collecter les adresses de livraison et de facturation. Cette opération nécessite un corps de requête JSON valide. Certaines valeurs par défaut seront appliquées si aucune valeur n’est fournie.
POST
/
commerce
/
payment-links
/
2026-09
/
payment-links
Créer un lien de paiement
curl --request POST \
--url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links \
--header 'Content-Type: application/json' \
--data '
{
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": true,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"currencyCode": "<string>",
"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>",
"taxObjectIds": [
"<string>"
],
"taxes": [
{
"label": "<string>",
"value": 123
}
],
"automatedSalesTaxEnabled": true,
"businessUnitId": "<string>",
"collectFullBillingAddress": true,
"collectShippingAddress": true,
"createContractOnPurchase": true,
"descriptionHtml": "<string>",
"discountCodeEnabled": true,
"discountObjectId": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"storePaymentMethodAtCheckout": true,
"successUrl": "<string>"
}
'import requests
url = "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links"
payload = {
"acceptedPaymentMethods": [],
"additionalFormFields": [
{
"isRequired": True,
"label": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"propertyName": "<string>",
"description": "<string>"
}
],
"currencyCode": "<string>",
"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>",
"taxObjectIds": ["<string>"],
"taxes": [
{
"label": "<string>",
"value": 123
}
],
"automatedSalesTaxEnabled": True,
"businessUnitId": "<string>",
"collectFullBillingAddress": True,
"collectShippingAddress": True,
"createContractOnPurchase": True,
"descriptionHtml": "<string>",
"discountCodeEnabled": True,
"discountObjectId": "<string>",
"domainId": "<string>",
"expirationSettings": {
"expirationDate": "2023-11-07T05:31:56Z",
"maxPurchases": 123
},
"storePaymentMethodAtCheckout": True,
"successUrl": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
acceptedPaymentMethods: [],
additionalFormFields: [
{
isRequired: true,
label: '<string>',
options: [{label: '<string>', value: '<string>', description: '<string>'}],
propertyName: '<string>',
description: '<string>'
}
],
currencyCode: '<string>',
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>',
taxObjectIds: ['<string>'],
taxes: [{label: '<string>', value: 123}],
automatedSalesTaxEnabled: true,
businessUnitId: '<string>',
collectFullBillingAddress: true,
collectShippingAddress: true,
createContractOnPurchase: true,
descriptionHtml: '<string>',
discountCodeEnabled: true,
discountObjectId: '<string>',
domainId: '<string>',
expirationSettings: {expirationDate: '2023-11-07T05:31:56Z', maxPurchases: 123},
storePaymentMethodAtCheckout: true,
successUrl: '<string>'
})
};
fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'acceptedPaymentMethods' => [
],
'additionalFormFields' => [
[
'isRequired' => true,
'label' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>',
'description' => '<string>'
]
],
'propertyName' => '<string>',
'description' => '<string>'
]
],
'currencyCode' => '<string>',
'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>',
'taxObjectIds' => [
'<string>'
],
'taxes' => [
[
'label' => '<string>',
'value' => 123
]
],
'automatedSalesTaxEnabled' => true,
'businessUnitId' => '<string>',
'collectFullBillingAddress' => true,
'collectShippingAddress' => true,
'createContractOnPurchase' => true,
'descriptionHtml' => '<string>',
'discountCodeEnabled' => true,
'discountObjectId' => '<string>',
'domainId' => '<string>',
'expirationSettings' => [
'expirationDate' => '2023-11-07T05:31:56Z',
'maxPurchases' => 123
],
'storePaymentMethodAtCheckout' => true,
'successUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links"
payload := strings.NewReader("{\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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links")
.header("Content-Type", "application/json")
.body("{\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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/commerce/payment-links/2026-09/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"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 \"currencyCode\": \"<string>\",\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 \"taxObjectIds\": [\n \"<string>\"\n ],\n \"taxes\": [\n {\n \"label\": \"<string>\",\n \"value\": 123\n }\n ],\n \"automatedSalesTaxEnabled\": true,\n \"businessUnitId\": \"<string>\",\n \"collectFullBillingAddress\": true,\n \"collectShippingAddress\": true,\n \"createContractOnPurchase\": true,\n \"descriptionHtml\": \"<string>\",\n \"discountCodeEnabled\": true,\n \"discountObjectId\": \"<string>\",\n \"domainId\": \"<string>\",\n \"expirationSettings\": {\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"maxPurchases\": 123\n },\n \"storePaymentMethodAtCheckout\": true,\n \"successUrl\": \"<string>\"\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
Corps
application/json
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 ».
Options disponibles:
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Un tableau d'objets PaymentLinkFormField représentant des champs de formulaire supplémentaires à inclure dans le lien de paiement.
Show child attributes
Show child attributes
Le code de devise du paiement, représenté sous forme de chaîne.
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 à appliquer au lien de paiement.
Show child attributes
Show child attributes
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 d'ID d'objets de lignes de produit, associés au lien de paiement, chacun représenté sous forme de chaîne de caractères.
Un tableau de lignes de produit, qui peuvent être personnalisées, issues d'un produit ou clonées, telles que définies par leurs schémas respectifs.
- CUSTOM
- FROM_PRODUCT
- CLONE
Show child attributes
Show child attributes
Le nom du lien de paiement. Il s'agit d'une valeur de chaîne.
L'état du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».
Options disponibles:
OFF, ON Un tableau d'identifiants de chaînes représentant les objets fiscaux associés au lien de paiement.
Un tableau d'objets TaxRequest, chacun représentant une taxe associée au lien de paiement.
Show child attributes
Show child attributes
Un booléen indiquant si la taxe de vente automatisée est activée.
Chaîne représentant l'identifiant de l'unité commerciale associée au lien de paiement.
Un booléen indiquant de collecter l'adresse de facturation complète lors du paiement.
Un booléen indiquant si l'adresse de livraison doit être recueillie pendant le processus de paiement.
Un booléen indiquant s'il faut créer un contrat lors de l'achat.
Show child attributes
Show child attributes
Une chaîne contenant la description HTML du lien de paiement.
Show child attributes
Show child attributes
Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.
Une chaîne représentant l'ID d'objet d'une réduction associée au lien de paiement.
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
Un booléen indiquant s'il faut enregistrer le mode de paiement lors du paiement.
Une chaîne qui définit l'URL vers laquelle rediriger après un paiement réussi.
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 ».
Options disponibles:
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 ».
Options disponibles:
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.
Dernière modification le 6 octobre 2026