Create a payment link

curl --request POST \
  --url https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceptedPaymentMethods": [],
  "additionalFormFields": [
    {
      "isRequired": true,
      "label": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "propertyName": "<string>",
      "description": "<string>"
    }
  ],
  "automatedSalesTaxEnabled": true,
  "collectFullBillingAddress": true,
  "collectShippingAddress": true,
  "currencyCode": "<string>",
  "discountCodeEnabled": true,
  "discountObjectIds": [
    "<string>"
  ],
  "enableDefaultCheckoutFees": true,
  "feeObjectIds": [
    "<string>"
  ],
  "includeEmailInSuccessRedirect": true,
  "isOneTimeUseEnabled": true,
  "lineItemObjectIds": [
    "<string>"
  ],
  "paymentLinkName": "<string>",
  "storePaymentMethodAtCheckout": true,
  "taxObjectIds": [
    "<string>"
  ],
  "businessUnitId": "<string>",
  "descriptionHtml": "<string>",
  "domainId": "<string>",
  "successUrl": "<string>"
}
'

import requests

url = "https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links"

payload = {
    "acceptedPaymentMethods": [],
    "additionalFormFields": [
        {
            "isRequired": True,
            "label": "<string>",
            "options": [
                {
                    "label": "<string>",
                    "value": "<string>",
                    "description": "<string>"
                }
            ],
            "propertyName": "<string>",
            "description": "<string>"
        }
    ],
    "automatedSalesTaxEnabled": True,
    "collectFullBillingAddress": True,
    "collectShippingAddress": True,
    "currencyCode": "<string>",
    "discountCodeEnabled": True,
    "discountObjectIds": ["<string>"],
    "enableDefaultCheckoutFees": True,
    "feeObjectIds": ["<string>"],
    "includeEmailInSuccessRedirect": True,
    "isOneTimeUseEnabled": True,
    "lineItemObjectIds": ["<string>"],
    "paymentLinkName": "<string>",
    "storePaymentMethodAtCheckout": True,
    "taxObjectIds": ["<string>"],
    "businessUnitId": "<string>",
    "descriptionHtml": "<string>",
    "domainId": "<string>",
    "successUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    acceptedPaymentMethods: [],
    additionalFormFields: [
      {
        isRequired: true,
        label: '<string>',
        options: [{label: '<string>', value: '<string>', description: '<string>'}],
        propertyName: '<string>',
        description: '<string>'
      }
    ],
    automatedSalesTaxEnabled: true,
    collectFullBillingAddress: true,
    collectShippingAddress: true,
    currencyCode: '<string>',
    discountCodeEnabled: true,
    discountObjectIds: ['<string>'],
    enableDefaultCheckoutFees: true,
    feeObjectIds: ['<string>'],
    includeEmailInSuccessRedirect: true,
    isOneTimeUseEnabled: true,
    lineItemObjectIds: ['<string>'],
    paymentLinkName: '<string>',
    storePaymentMethodAtCheckout: true,
    taxObjectIds: ['<string>'],
    businessUnitId: '<string>',
    descriptionHtml: '<string>',
    domainId: '<string>',
    successUrl: '<string>'
  })
};

fetch('https://api.hubapi.com/commerce/payment-links/2026-09-beta/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-beta/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>'
        ]
    ],
    'automatedSalesTaxEnabled' => true,
    'collectFullBillingAddress' => true,
    'collectShippingAddress' => true,
    'currencyCode' => '<string>',
    'discountCodeEnabled' => true,
    'discountObjectIds' => [
        '<string>'
    ],
    'enableDefaultCheckoutFees' => true,
    'feeObjectIds' => [
        '<string>'
    ],
    'includeEmailInSuccessRedirect' => true,
    'isOneTimeUseEnabled' => true,
    'lineItemObjectIds' => [
        '<string>'
    ],
    'paymentLinkName' => '<string>',
    'storePaymentMethodAtCheckout' => true,
    'taxObjectIds' => [
        '<string>'
    ],
    'businessUnitId' => '<string>',
    'descriptionHtml' => '<string>',
    'domainId' => '<string>',
    'successUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/commerce/payment-links/2026-09-beta/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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links")
  .header("Authorization", "Bearer <token>")
  .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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "acceptedPaymentMethods": [],
  "additionalFormFields": [
    {
      "isRequired": true,
      "label": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "propertyName": "<string>",
      "description": "<string>"
    }
  ],
  "archived": true,
  "automatedSalesTaxEnabled": true,
  "checkoutFeeIds": [
    "<string>"
  ],
  "collectFullBillingAddress": true,
  "collectShippingAddress": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "discountCodeEnabled": true,
  "discounts": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "fees": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "formGuid": "<string>",
  "id": "<string>",
  "includeEmailInSuccessRedirect": true,
  "isOneTimeUseEnabled": true,
  "lineItems": [
    {
      "id": "<string>",
      "name": "<string>",
      "pricing": {
        "prices": [
          {
            "amount": 123,
            "currencyCode": "<string>",
            "price": 123,
            "maxQuantity": "<string>"
          }
        ]
      },
      "quantity": 123,
      "acv": 123,
      "allowBuyerSelectedQuantity": true,
      "amount": 123,
      "archived": true,
      "archivedAt": "<string>",
      "arr": 123,
      "billingCycleAnchorDate": "<string>",
      "billingPeriodEndDate": "<string>",
      "billingPeriodStartDate": "<string>",
      "billingStartDelayDays": 123,
      "billingStartDelayMonths": 123,
      "buyerSelectedQuantityMax": 123,
      "buyerSelectedQuantityMin": 123,
      "createdAt": "<string>",
      "description": "<string>",
      "discount": 123,
      "discountPercentage": 123,
      "effectiveUnitPrice": 123,
      "externalId": "<string>",
      "images": "<string>",
      "isEditablePrice": true,
      "isOptional": true,
      "lineItemCurrencyCode": "<string>",
      "mrr": 123,
      "positionOnQuote": 123,
      "postTaxAmount": 123,
      "preDiscountAmount": 123,
      "price": 123,
      "priceBookId": "<string>",
      "productId": "<string>",
      "productType": "<string>",
      "rampKey": "<string>",
      "recurringBillingDayOfMonth": 123,
      "recurringBillingEndDate": "<string>",
      "recurringBillingNumberOfPayments": 123,
      "recurringBillingPeriod": "<string>",
      "recurringBillingStartDate": "<string>",
      "richTextDescription": "<string>",
      "sku": "<string>",
      "tax": 123,
      "tcv": 123,
      "termInMonths": 123,
      "tierAmount": 123,
      "totalDiscount": 123,
      "updatedAt": "<string>",
      "variantId": "<string>"
    }
  ],
  "paymentLinkName": "<string>",
  "paymentLinkUrl": "<string>",
  "storePaymentMethodAtCheckout": true,
  "taxes": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "businessUnitId": "<string>",
  "dealConfigurations": {
    "createNewDealOnPurchase": true,
    "pipelineStageId": "<string>"
  },
  "descriptionHtml": "<string>",
  "domainId": "<string>",
  "successUrl": "<string>"
}

{
  "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"
  }
}

POST

commerce

payment-links

2026-09-beta

payment-links

Create a payment link

curl --request POST \
  --url https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceptedPaymentMethods": [],
  "additionalFormFields": [
    {
      "isRequired": true,
      "label": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "propertyName": "<string>",
      "description": "<string>"
    }
  ],
  "automatedSalesTaxEnabled": true,
  "collectFullBillingAddress": true,
  "collectShippingAddress": true,
  "currencyCode": "<string>",
  "discountCodeEnabled": true,
  "discountObjectIds": [
    "<string>"
  ],
  "enableDefaultCheckoutFees": true,
  "feeObjectIds": [
    "<string>"
  ],
  "includeEmailInSuccessRedirect": true,
  "isOneTimeUseEnabled": true,
  "lineItemObjectIds": [
    "<string>"
  ],
  "paymentLinkName": "<string>",
  "storePaymentMethodAtCheckout": true,
  "taxObjectIds": [
    "<string>"
  ],
  "businessUnitId": "<string>",
  "descriptionHtml": "<string>",
  "domainId": "<string>",
  "successUrl": "<string>"
}
'

import requests

url = "https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links"

payload = {
    "acceptedPaymentMethods": [],
    "additionalFormFields": [
        {
            "isRequired": True,
            "label": "<string>",
            "options": [
                {
                    "label": "<string>",
                    "value": "<string>",
                    "description": "<string>"
                }
            ],
            "propertyName": "<string>",
            "description": "<string>"
        }
    ],
    "automatedSalesTaxEnabled": True,
    "collectFullBillingAddress": True,
    "collectShippingAddress": True,
    "currencyCode": "<string>",
    "discountCodeEnabled": True,
    "discountObjectIds": ["<string>"],
    "enableDefaultCheckoutFees": True,
    "feeObjectIds": ["<string>"],
    "includeEmailInSuccessRedirect": True,
    "isOneTimeUseEnabled": True,
    "lineItemObjectIds": ["<string>"],
    "paymentLinkName": "<string>",
    "storePaymentMethodAtCheckout": True,
    "taxObjectIds": ["<string>"],
    "businessUnitId": "<string>",
    "descriptionHtml": "<string>",
    "domainId": "<string>",
    "successUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    acceptedPaymentMethods: [],
    additionalFormFields: [
      {
        isRequired: true,
        label: '<string>',
        options: [{label: '<string>', value: '<string>', description: '<string>'}],
        propertyName: '<string>',
        description: '<string>'
      }
    ],
    automatedSalesTaxEnabled: true,
    collectFullBillingAddress: true,
    collectShippingAddress: true,
    currencyCode: '<string>',
    discountCodeEnabled: true,
    discountObjectIds: ['<string>'],
    enableDefaultCheckoutFees: true,
    feeObjectIds: ['<string>'],
    includeEmailInSuccessRedirect: true,
    isOneTimeUseEnabled: true,
    lineItemObjectIds: ['<string>'],
    paymentLinkName: '<string>',
    storePaymentMethodAtCheckout: true,
    taxObjectIds: ['<string>'],
    businessUnitId: '<string>',
    descriptionHtml: '<string>',
    domainId: '<string>',
    successUrl: '<string>'
  })
};

fetch('https://api.hubapi.com/commerce/payment-links/2026-09-beta/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-beta/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>'
        ]
    ],
    'automatedSalesTaxEnabled' => true,
    'collectFullBillingAddress' => true,
    'collectShippingAddress' => true,
    'currencyCode' => '<string>',
    'discountCodeEnabled' => true,
    'discountObjectIds' => [
        '<string>'
    ],
    'enableDefaultCheckoutFees' => true,
    'feeObjectIds' => [
        '<string>'
    ],
    'includeEmailInSuccessRedirect' => true,
    'isOneTimeUseEnabled' => true,
    'lineItemObjectIds' => [
        '<string>'
    ],
    'paymentLinkName' => '<string>',
    'storePaymentMethodAtCheckout' => true,
    'taxObjectIds' => [
        '<string>'
    ],
    'businessUnitId' => '<string>',
    'descriptionHtml' => '<string>',
    'domainId' => '<string>',
    'successUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/commerce/payment-links/2026-09-beta/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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links")
  .header("Authorization", "Bearer <token>")
  .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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/commerce/payment-links/2026-09-beta/payment-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
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  \"automatedSalesTaxEnabled\": true,\n  \"collectFullBillingAddress\": true,\n  \"collectShippingAddress\": true,\n  \"currencyCode\": \"<string>\",\n  \"discountCodeEnabled\": true,\n  \"discountObjectIds\": [\n    \"<string>\"\n  ],\n  \"enableDefaultCheckoutFees\": true,\n  \"feeObjectIds\": [\n    \"<string>\"\n  ],\n  \"includeEmailInSuccessRedirect\": true,\n  \"isOneTimeUseEnabled\": true,\n  \"lineItemObjectIds\": [\n    \"<string>\"\n  ],\n  \"paymentLinkName\": \"<string>\",\n  \"storePaymentMethodAtCheckout\": true,\n  \"taxObjectIds\": [\n    \"<string>\"\n  ],\n  \"businessUnitId\": \"<string>\",\n  \"descriptionHtml\": \"<string>\",\n  \"domainId\": \"<string>\",\n  \"successUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "acceptedPaymentMethods": [],
  "additionalFormFields": [
    {
      "isRequired": true,
      "label": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "propertyName": "<string>",
      "description": "<string>"
    }
  ],
  "archived": true,
  "automatedSalesTaxEnabled": true,
  "checkoutFeeIds": [
    "<string>"
  ],
  "collectFullBillingAddress": true,
  "collectShippingAddress": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>",
  "discountCodeEnabled": true,
  "discounts": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "fees": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "formGuid": "<string>",
  "id": "<string>",
  "includeEmailInSuccessRedirect": true,
  "isOneTimeUseEnabled": true,
  "lineItems": [
    {
      "id": "<string>",
      "name": "<string>",
      "pricing": {
        "prices": [
          {
            "amount": 123,
            "currencyCode": "<string>",
            "price": 123,
            "maxQuantity": "<string>"
          }
        ]
      },
      "quantity": 123,
      "acv": 123,
      "allowBuyerSelectedQuantity": true,
      "amount": 123,
      "archived": true,
      "archivedAt": "<string>",
      "arr": 123,
      "billingCycleAnchorDate": "<string>",
      "billingPeriodEndDate": "<string>",
      "billingPeriodStartDate": "<string>",
      "billingStartDelayDays": 123,
      "billingStartDelayMonths": 123,
      "buyerSelectedQuantityMax": 123,
      "buyerSelectedQuantityMin": 123,
      "createdAt": "<string>",
      "description": "<string>",
      "discount": 123,
      "discountPercentage": 123,
      "effectiveUnitPrice": 123,
      "externalId": "<string>",
      "images": "<string>",
      "isEditablePrice": true,
      "isOptional": true,
      "lineItemCurrencyCode": "<string>",
      "mrr": 123,
      "positionOnQuote": 123,
      "postTaxAmount": 123,
      "preDiscountAmount": 123,
      "price": 123,
      "priceBookId": "<string>",
      "productId": "<string>",
      "productType": "<string>",
      "rampKey": "<string>",
      "recurringBillingDayOfMonth": 123,
      "recurringBillingEndDate": "<string>",
      "recurringBillingNumberOfPayments": 123,
      "recurringBillingPeriod": "<string>",
      "recurringBillingStartDate": "<string>",
      "richTextDescription": "<string>",
      "sku": "<string>",
      "tax": 123,
      "tcv": 123,
      "termInMonths": 123,
      "tierAmount": 123,
      "totalDiscount": 123,
      "updatedAt": "<string>",
      "variantId": "<string>"
    }
  ],
  "paymentLinkName": "<string>",
  "paymentLinkUrl": "<string>",
  "storePaymentMethodAtCheckout": true,
  "taxes": [
    {
      "id": "<string>",
      "archived": true,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "label": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "businessUnitId": "<string>",
  "dealConfigurations": {
    "createNewDealOnPurchase": true,
    "pipelineStageId": "<string>"
  },
  "descriptionHtml": "<string>",
  "domainId": "<string>",
  "successUrl": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Authorizations

Authorization

string

header

required

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

Body

application/json

acceptedPaymentMethods

enum<string>[]

required

An array of strings representing the payment methods accepted for this link. Valid values include 'CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.

Available options:

CARD,

ACH,

SEPA,

BACS,

PADS

additionalFormFields

object[]

required

An array of PublicPaymentLinkFormField objects representing additional form fields to be included in the payment link. Email is included by default and should not be specified here.

Show child attributes

automatedSalesTaxEnabled

boolean

required

A boolean indicating whether automated sales tax calculation is enabled.

collectFullBillingAddress

boolean

required

A boolean indicating whether the full billing address should be collected during checkout.

collectShippingAddress

boolean

required

A boolean indicating whether the shipping address should be collected during checkout.

currencyCode

string

required

The currency code for the payment, represented as a string.

discountCodeEnabled

boolean

required

A boolean indicating whether discount codes are enabled for this payment link.

discountObjectIds

string[]

required

An array of strings representing the object IDs of discounts associated with the payment link.

enableDefaultCheckoutFees

boolean

required

A boolean indicating whether default checkout fees are enabled.

feeObjectIds

string[]

required

An array of strings representing the object IDs of fees associated with the payment link.

includeEmailInSuccessRedirect

boolean

required

A boolean indicating whether to include the email in the success redirect URL.

isOneTimeUseEnabled

boolean

required

A boolean indicating whether the payment link is for one-time use only.

lineItemObjectIds

string[]

required

An array of strings representing the object IDs of line items associated with the payment link.

paymentLinkName

string

required

The name of the payment link, represented as a string.

state

enum<string>

required

The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'.

Available options:

OFF,

ON

storePaymentMethodAtCheckout

boolean

required

A boolean indicating whether the payment method should be stored at checkout.

taxObjectIds

string[]

required

An array of strings representing the object IDs of taxes associated with the payment link.

businessUnitId

string

A string representing the business unit ID associated with the payment link.

dealConfigurations

object

Show child attributes

descriptionHtml

string

A string containing the HTML description of the payment link.

discount

object

Show child attributes

domainId

string

A string representing the domain ID associated with the payment link.

successUrl

string

A string representing the URL to redirect to upon successful payment.

Response

successful operation

acceptedPaymentMethods

enum<string>[]

required

An array of accepted payment methods for the link, which can include 'CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.

Available options:

CARD,

ACH,

SEPA,

BACS,

PADS

additionalFormFields

object[]

required

An array of additional form fields included in the payment link.

Show child attributes

archived

boolean

required

A boolean indicating if the payment link is archived.

automatedSalesTaxEnabled

boolean

required

A boolean indicating if automated sales tax calculation is enabled.

checkoutFeeIds

string[]

required

An array of strings representing the IDs of checkout fees associated with the payment link.

collectFullBillingAddress

boolean

required

A boolean indicating if the full billing address should be collected during checkout.

collectShippingAddress

boolean

required

A boolean indicating if the shipping address should be collected during checkout.

createdAt

string<date-time>

required

A string representing the date and time when the payment link was created, in ISO 8601 format.

currencyCode

string

required

The currency code for the payment link, represented as a string.

discountCodeEnabled

boolean

required

A boolean indicating if discount codes are enabled for the payment link.

discounts

object[]

required

An array of discount objects associated with the payment link.

Show child attributes

fees

object[]

required

An array of fee objects associated with the payment link.

Show child attributes

formGuid

string

required

A string representing the form GUID associated with the payment link.

string

required

A string representing the unique identifier of the payment link.

includeEmailInSuccessRedirect

boolean

required

A boolean indicating if the email should be included in the success redirect.

isOneTimeUseEnabled

boolean

required

A boolean indicating if the payment link is enabled for one-time use only.

lineItems

object[]

required

An array of line items associated with the payment link.

Show child attributes

paymentLinkName

string

required

The name of the payment link, represented as a string.

paymentLinkUrl

string

required

A string representing the URL of the payment link.

state

enum<string>

required

The current state of the payment link, which can be either 'ON' or 'OFF'.

Available options:

OFF,

ON

storePaymentMethodAtCheckout

boolean

required

A boolean indicating if the payment method should be stored at checkout.

taxes

object[]

required

An array of tax objects associated with the payment link.

Show child attributes

updatedAt

string<date-time>

required

A string representing the date and time when the payment link was last updated, in ISO 8601 format.

archivedAt

string<date-time>

A string representing the date and time when the payment link was archived, in ISO 8601 format.

businessUnitId

string

A string representing the business unit ID associated with the payment link.

dealConfigurations

object

Show child attributes

descriptionHtml

string

A string containing the HTML description of the payment link.

domainId

string

A string representing the domain ID associated with the payment link.

successUrl

string

A string representing the URL to redirect to upon successful payment.

Last modified on July 2, 2026

⌘I