Criar um link de pagamento
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"
}
}Links de pagamento
Create a payment link
Crie um novo link de pagamento na sua conta HubSpot. Este endpoint permite especificar vários atributos para o link de pagamento, como métodos de pagamento aceitos, moeda e campos de formulário adicionais. O link de pagamento pode ser configurado para uso único e também pode coletar endereços de entrega e cobrança. Esta operação requer um corpo de solicitação JSON válido. Alguns padrões serão aplicados se nenhum valor for fornecido.
POST
/
commerce
/
payment-links
/
2026-09
/
payment-links
Criar um link de pagamento
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
Corpo
application/json
Uma matriz de métodos de pagamento aceitos para o link de pagamento. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" e "PADS".
Opções disponíveis:
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Uma matriz de objetos PaymentLinkFormField que representam campos de formulário adicionais a serem incluídos no link de pagamento.
Show child attributes
Show child attributes
O código da moeda para o pagamento, representado como uma string.
Um booleano indicando se as taxas de checkout padrão estão ativadas.
Uma matriz de strings que representam os IDs de objetos de taxas associados ao link de pagamento.
Uma matriz de objetos FeeRequest, representando as taxas a serem aplicadas ao link de pagamento.
Show child attributes
Show child attributes
Um booleano que indica se o e-mail deve ser incluído no URL de redirecionamento bem-sucedido.
Um booleano que indica se o link de pagamento está ativado para uso único.
Uma matriz de IDs de objetos de item de linha associados ao link de pagamento, cada um representado como uma string.
Uma matriz de itens de linha, que podem ser personalizados, de um produto ou clonados, conforme definido por seus respectivos esquemas.
- CUSTOM
- FROM_PRODUCT
- CLONE
Show child attributes
Show child attributes
O nome do link de pagamento. É um valor de string.
O status do link de pagamento, representado como uma string. Os valores válidos são "ON" e "OFF".
Opções disponíveis:
OFF, ON Uma matriz de IDs de string que representam objetos de imposto associados ao link de pagamento.
Uma matriz de objetos TaxRequest, cada um representando um imposto associado ao link de pagamento.
Show child attributes
Show child attributes
Um booleano que indica se o imposto de vendas automatizado está ativado.
Uma string que representa o ID da unidade de negócios associado ao link de pagamento.
Um booleano que indica se o endereço de cobrança completo deve ser coletado durante o checkout.
Um booleano que indica se o endereço de entrega deve ser coletado durante o checkout.
Um booleano que indica se um contrato deve ser criado no momento da compra.
Show child attributes
Show child attributes
Uma string que contém a descrição HTML do link de pagamento.
Show child attributes
Show child attributes
Um booleano que indica se os códigos de desconto estão ativados para o link de pagamento.
Uma string que representa o ID de objeto de um desconto associado ao link de pagamento.
O ID do domínio associado ao link de pagamento, representado como uma string.
Show child attributes
Show child attributes
Um booleano que indica se o método de pagamento deve ser armazenado no checkout.
Uma string que define o URL para redirecionar após o pagamento bem-sucedido.
Resposta
successful operation
Uma matriz de métodos de pagamento aceitos para o link de pagamento. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" e "PADS".
Opções disponíveis:
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Uma matriz de campos de formulário adicionais incluídos no link de pagamento.
Show child attributes
Show child attributes
Um booleano que indica se o link de pagamento está arquivado.
Um booleano que indica se o imposto de vendas automatizado está ativado para o link de pagamento.
Uma matriz de IDs de taxas de checkout associadas ao link de pagamento.
Um booleano que indica se o endereço de cobrança completo deve ser coletado durante o checkout.
Um valor booleano que indica se o endereço de entrega deve ser coletado durante o checkout.
O número de compras concluídas feitas por meio deste link de pagamento.
Um booleano que indica se um contrato deve ser criado no momento da compra.
O código da moeda para o link de pagamento, representado como uma string.
Um booleano que indica se os códigos de desconto estão ativados para o link de pagamento.
Uma matriz de objetos de desconto associados ao link de pagamento.
Show child attributes
Show child attributes
Uma matriz de objetos de taxa associados ao link de pagamento.
Show child attributes
Show child attributes
O GUID do formulário associado ao link de pagamento, representado como uma string.
O identificador exclusivo do link de pagamento, representado como uma string.
Um booleano que indica se o e-mail deve ser incluído no URL de redirecionamento bem-sucedido.
Um booleano que indica se o link de pagamento está ativado para uso único.
Uma matriz de itens de linha associados ao link de pagamento.
Show child attributes
Show child attributes
O nome do link de pagamento, representado como uma string.
O URL do link de pagamento, representado como uma string.
O estado atual do link de pagamento, representado como uma string. Os valores válidos incluem "ON" e "OFF".
Opções disponíveis:
OFF, ON Um booleano que indica se o método de pagamento deve ser armazenado no checkout.
Uma matriz de objetos de impostos associados ao link de pagamento.
Show child attributes
Show child attributes
A data e a hora em que o link de pagamento foi arquivado, no formato ISO 8601.
O ID da unidade de negócio associada ao link de pagamento, representado como uma string.
A data e a hora em que o link de pagamento foi criado, no formato ISO 8601.
Show child attributes
Show child attributes
A descrição HTML do link de pagamento, representada como uma string.
O ID de domínio associado ao link de pagamento, representado como uma string.
Show child attributes
Show child attributes
O URL ao qual redirecionar após o pagamento bem-sucedido, representado como uma string.
A data e a hora da última atualização do link de pagamento, no formato ISO 8601.
Última modificação em 6 de outubro de 2026