Retrieve a payment link

Récupérer le lien de paiement

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}

Récupérer le lien de paiement

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

Paramètres de chemin

paymentLinkId

string

requis

L'identifiant unique du lien de paiement à récupérer.

Paramètres de requête

archived

boolean

défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

Réponse

successful operation

acceptedPaymentMethods

enum<string>[]

requis

Un ensemble de méthodes de paiement acceptées pour le lien de paiement. Les valeurs valides incluent : « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS » et « PADS ».

Options disponibles:

CREDIT_OR_DEBIT_CARD,

ACH,

SEPA,

BACS,

PADS,

AFFIRM,

KLARNA

additionalFormFields

object[]

requis

Un ensemble de champs de formulaire supplémentaires inclus dans le lien de paiement.

Show child attributes

archived

boolean

requis

Un booléen indiquant si le lien de paiement est archivé.

automatedSalesTaxEnabled

boolean

requis

Un booléen indiquant si la taxe de vente automatisée est activée pour le lien de paiement.

checkoutFeeIds

string[]

requis

Un tableau d'ID de frais associés au lien de paiement.

collectFullBillingAddress

boolean

requis

Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement.

collectShippingAddress

boolean

requis

Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement.

completedPurchaseCount

integer<int32>

requis

Le nombre d'achats effectués via ce lien de paiement.

createContractOnPurchase

boolean

requis

Un booléen indiquant si un contrat doit être créé lors de l'achat.

currencyCode

string

requis

Le code de devise du lien de paiement, représenté sous forme de chaîne.

discountCodeEnabled

boolean

requis

Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.

discounts

object[]

requis

Un tableau d'objets en réduction associés au lien de paiement.

Show child attributes

fees

object[]

requis

Un tableau d'objets de frais associés au lien de paiement.

Show child attributes

formGuid

string

requis

Le GUID du formulaire associé au lien de paiement, représenté sous forme de chaîne de caractères.

string

requis

L'identifiant unique du lien de paiement, représenté sous forme de chaîne de caractères.

includeEmailInSuccessRedirect

boolean

requis

Un booléen indiquant s'il faut inclure l'e-mail dans l'URL de redirection en cas de succès.

isOneTimeUseEnabled

boolean

requis

Un booléen indiquant si le lien de paiement est activé pour une utilisation unique.

lineItems

object[]

requis

Un tableau de lignes de produit associées au lien de paiement.

Show child attributes

paymentLinkName

string

requis

Le nom du lien de paiement, représenté sous forme de chaîne de caractères.

paymentLinkUrl

string

requis

L'URL du lien de paiement, représentée sous forme de chaîne de caractères.

state

enum<string>

requis

L'état actuel du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».

Options disponibles:

OFF,

ON

storePaymentMethodAtCheckout

boolean

requis

Un booléen indiquant s'il faut enregistrer le mode de paiement au moment du règlement.

taxes

object[]

requis

Un tableau d'objets fiscaux associés au lien de paiement.

Show child attributes

archivedAt

string<date-time>

La date et l'heure d'archivage du lien de paiement, au format ISO 8601.

businessUnitId

string

L'ID de l'unité commerciale associée au lien de paiement, représenté sous forme de chaîne de caractères.

createdAt

string<date-time>

La date et l'heure de création du lien de paiement, au format ISO 8601.

dealConfigurations

object

Show child attributes

descriptionHtml

string

La description HTML du lien de paiement, représentée sous forme de chaîne.

domainId

string

L'ID de domaine associé au lien de paiement, représenté sous forme de chaîne de caractères.

expirationSettings

object

Show child attributes

successUrl

string

L'URL de redirection en cas de paiement réussi, représentée sous forme de chaîne de caractères.

updatedAt

string<date-time>

La date et l'heure de la dernière mise à jour du lien de paiement, au format ISO 8601.

Dernière modification le 6 octobre 2026

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Data Studio

Événements

Fichiers

Marketing

Rendez-vous

Chiffre d'affaires

Webhooks

Journal des webhooks

Retrieve a payment link

Paramètres de chemin

Paramètres de requête

Réponse