Retrieve a payment link

Recuperar link de pagamento

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}

Recuperar link de pagamento

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

Parâmetros de caminho

paymentLinkId

string

obrigatório

O identificador exclusivo do link de pagamento a ser recuperado.

Parâmetros de consulta

archived

boolean

padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

Resposta

successful operation

acceptedPaymentMethods

enum<string>[]

obrigatório

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

additionalFormFields

object[]

obrigatório

Uma matriz de campos de formulário adicionais incluídos no link de pagamento.

Show child attributes

archived

boolean

obrigatório

Um booleano que indica se o link de pagamento está arquivado.

automatedSalesTaxEnabled

boolean

obrigatório

Um booleano que indica se o imposto de vendas automatizado está ativado para o link de pagamento.

checkoutFeeIds

string[]

obrigatório

Uma matriz de IDs de taxas de checkout associadas ao link de pagamento.

collectFullBillingAddress

boolean

obrigatório

Um booleano que indica se o endereço de cobrança completo deve ser coletado durante o checkout.

collectShippingAddress

boolean

obrigatório

Um valor booleano que indica se o endereço de entrega deve ser coletado durante o checkout.

completedPurchaseCount

integer<int32>

obrigatório

O número de compras concluídas feitas por meio deste link de pagamento.

createContractOnPurchase

boolean

obrigatório

Um booleano que indica se um contrato deve ser criado no momento da compra.

currencyCode

string

obrigatório

O código da moeda para o link de pagamento, representado como uma string.

discountCodeEnabled

boolean

obrigatório

Um booleano que indica se os códigos de desconto estão ativados para o link de pagamento.

discounts

object[]

obrigatório

Uma matriz de objetos de desconto associados ao link de pagamento.

Show child attributes

fees

object[]

obrigatório

Uma matriz de objetos de taxa associados ao link de pagamento.

Show child attributes

formGuid

string

obrigatório

O GUID do formulário associado ao link de pagamento, representado como uma string.

string

obrigatório

O identificador exclusivo do link de pagamento, representado como uma string.

includeEmailInSuccessRedirect

boolean

obrigatório

Um booleano que indica se o e-mail deve ser incluído no URL de redirecionamento bem-sucedido.

isOneTimeUseEnabled

boolean

obrigatório

Um booleano que indica se o link de pagamento está ativado para uso único.

lineItems

object[]

obrigatório

Uma matriz de itens de linha associados ao link de pagamento.

Show child attributes

paymentLinkName

string

obrigatório

O nome do link de pagamento, representado como uma string.

paymentLinkUrl

string

obrigatório

O URL do link de pagamento, representado como uma string.

state

enum<string>

obrigatório

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

storePaymentMethodAtCheckout

boolean

obrigatório

Um booleano que indica se o método de pagamento deve ser armazenado no checkout.

taxes

object[]

obrigatório

Uma matriz de objetos de impostos associados ao link de pagamento.

Show child attributes

archivedAt

string<date-time>

A data e a hora em que o link de pagamento foi arquivado, no formato ISO 8601.

businessUnitId

string

O ID da unidade de negócio associada ao link de pagamento, representado como uma string.

createdAt

string<date-time>

A data e a hora em que o link de pagamento foi criado, no formato ISO 8601.

dealConfigurations

object

Show child attributes

descriptionHtml

string

A descrição HTML do link de pagamento, representada como uma string.

domainId

string

O ID de domínio associado ao link de pagamento, representado como uma string.

expirationSettings

object

Show child attributes

successUrl

string

O URL ao qual redirecionar após o pagamento bem-sucedido, representado como uma string.

updatedAt

string<date-time>

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

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Data Studio

Eventos

Arquivos

Marketing

Reuniões

Receita

Webhooks

Diário de Webhooks

Retrieve a payment link

Parâmetros de caminho

Parâmetros de consulta

Resposta