Retrieve a payment link

Retrieve payment link

curl --request GET \
  --url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}

const options = {method: 'GET'};

fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

GET

commerce

payment-links

2026-09

payment-links

{paymentLinkId}

Retrieve payment link

curl --request GET \
  --url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}

const options = {method: 'GET'};

fetch('https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

Required Scopes

Path Parameters

paymentLinkId

string

required

The unique identifier of the payment link to retrieve.

Query Parameters

archived

boolean

default:false

Whether to return only results that have been archived.

Response

successful operation

acceptedPaymentMethods

enum<string>[]

required

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

Available options:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

additionalFormFields

object[]

required

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

Show child attributes

archived

boolean

required

A boolean indicating whether the payment link is archived.

automatedSalesTaxEnabled

boolean

required

A boolean indicating whether automated sales tax is enabled for the payment link.

checkoutFeeIds

string[]

required

An array of checkout fee IDs associated with the payment link.

collectFullBillingAddress

boolean

required

A boolean indicating whether to collect the full billing address during checkout.

collectShippingAddress

boolean

required

A boolean indicating whether to collect the shipping address during checkout.

completedPurchaseCount

integer<int32>

required

The number of completed purchases made through this payment link.

createContractOnPurchase

boolean

required

A boolean indicating whether a contract should be created upon purchase.

currencyCode

string

required

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

discountCodeEnabled

boolean

required

A boolean indicating whether 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

The form GUID associated with the payment link, represented as a string.

string

required

The unique identifier for the payment link, represented as a string.

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 enabled for one-time use.

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

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

state

enum<string>

required

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

Available options:

OFF,

ON

storePaymentMethodAtCheckout

boolean

required

A boolean indicating whether to store the payment method at checkout.

taxes

object[]

required

An array of tax objects associated with the payment link.

Show child attributes

archivedAt

string<date-time>

The date and time when the payment link was archived, in ISO 8601 format.

businessUnitId

string

The business unit ID associated with the payment link, represented as a string.

createdAt

string<date-time>

The date and time when the payment link was created, in ISO 8601 format.

dealConfigurations

object

Show child attributes

descriptionHtml

string

The HTML description of the payment link, represented as a string.

domainId

string

The domain ID associated with the payment link, represented as a string.

expirationSettings

object

Show child attributes

successUrl

string

The URL to redirect to upon successful payment, represented as a string.

updatedAt

string<date-time>

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

Last modified on September 9, 2026

Account & Settings

App Management

Authentication

Automation

CMS

Communication preferences

Conversations

CRM

Data studio

Events

Files

Marketing

Meetings

Revenue

Webhooks

Webhooks journal

Retrieve a payment link

Path Parameters

Query Parameters

Response