Retrieve a payment link

Recuperar enlace de pago

curl --request GET \
  --url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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)

	req.Header.Add("Authorization", "Bearer <token>")

	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)
request["Authorization"] = 'Bearer <token>'

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

Recuperar enlace de pago

curl --request GET \
  --url https://api.hubapi.com/commerce/payment-links/2026-09/payment-links/{paymentLinkId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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)

	req.Header.Add("Authorization", "Bearer <token>")

	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)
request["Authorization"] = 'Bearer <token>'

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

Autorizaciones

Authorization

string

header

requerido

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

FlowAuthorization Code

Authorization URL: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token

Scopes1

payment-links-read

Parámetros de ruta

paymentLinkId

string

requerido

Parámetros de consulta

archived

boolean

predeterminado:false

Si se devolverán solo los resultados que se han archivado.

Respuesta

successful operation

acceptedPaymentMethods

enum<string>[]

requerido

Una lista de métodos de pago aceptados para el enlace de pago. Los valores válidos son "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" y "PADS".

Opciones disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

additionalFormFields

object[]

requerido

Un conjunto de campos de formulario adicionales incluidos en el enlace de pago.

Show child attributes

archived

boolean

requerido

Un valor booleano que indica si el enlace de pago está archivado.

automatedSalesTaxEnabled

boolean

requerido

Un booleano que indica si el impuesto de ventas automatizado está habilitado para el enlace de pago.

checkoutFeeIds

string[]

requerido

Un conjunto de ID de cargos de pago asociados al enlace de pago.

collectFullBillingAddress

boolean

requerido

Un valor booleano que indica si se debe recoger la dirección de facturación completa durante el proceso de pago.

collectShippingAddress

boolean

requerido

Un valor booleano que indica si se debe recoger la dirección de envío durante el proceso de pago.

createContractOnPurchase

boolean

requerido

currencyCode

string

requerido

El código de divisa para el enlace de pago, representado como una cadena.

discountCodeEnabled

boolean

requerido

Un booleano que indica si los códigos de descuento están habilitados en el enlace de pago.

discounts

object[]

requerido

Un conjunto de objetos de descuento asociados al enlace de pago.

Show child attributes

fees

object[]

requerido

Un conjunto de objetos de tarifas asociados con el enlace de pago.

Show child attributes

formGuid

string

requerido

El GUID del formulario asociado al enlace de pago, representado como una cadena.

string

requerido

El identificador único del enlace de pago, representado como una cadena.

includeEmailInSuccessRedirect

boolean

requerido

Un valor booleano que indica si se debe incluir el correo electrónico en la URL de redireccionamiento en caso de acción correcta.

isOneTimeUseEnabled

boolean

requerido

Un valor booleano que indica si el enlace de pago está habilitado para un solo uso.

lineItems

object[]

requerido

Un conjunto de elementos de pedido asociados con el enlace de pago.

Show child attributes

paymentLinkName

string

requerido

El nombre del enlace de pago, representado como una cadena.

paymentLinkUrl

string

requerido

La URL del enlace de pago, representada como una cadena.

state

enum<string>

requerido

El estado actual del enlace de pago, representado como una cadena. Los valores válidos son "ON" y "OFF".

Opciones disponibles:

OFF,

ON

storePaymentMethodAtCheckout

boolean

requerido

Un booleano que indica si se debe guardar el método de pago al finalizar el pago.

taxes

object[]

requerido

Un conjunto de objetos de impuestos asociados con el enlace de pago.

Show child attributes

archivedAt

string<date-time>

La fecha y hora en que se archivó el enlace de pago, en formato ISO 8601.

businessUnitId

string

El ID de la unidad de negocio asociado al enlace de pago, representado como una cadena.

createdAt

string<date-time>

La fecha y hora en que se creó el enlace de pago, en formato ISO 8601.

dealConfigurations

object

Show child attributes

descriptionHtml

string

La descripción HTML del enlace de pago, representada como una cadena.

domainId

string

El ID de dominio asociado al enlace de pago, representado como una cadena.

successUrl

string

La URL a la que se hará redireccionamiento tras un pago exitoso, representada como una cadena.

updatedAt

string<date-time>

La fecha y hora de la última actualización del enlace de pago, en formato ISO 8601.

Última modificación el 6 de octubre de 2026

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Data Studio

Eventos

Archivos

Marketing

Reuniones

Ingresos

Webhooks

Registro de webhooks

Retrieve a payment link

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Respuesta