v27

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0152590.1 KB

Basic

Retrieve payment link

Retrieve details of a specific payment link using its unique identifier. This endpoint allows you to access information about the payment link, including its status and configuration. It is useful for checking the current settings or status of a payment link in your HubSpot account.

get/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}

Path parameters

paymentLinkIdstring required

The unique identifier of the payment link to retrieve.

Query parameters

archivedboolean

Whether to return only results that have been archived. Defaults to false.

Response

successful operation

acceptedPaymentMethodsstring[] required

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

archivedboolean required

A boolean indicating whether the payment link is archived.

archivedAtstring date-time

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

automatedSalesTaxEnabledboolean required

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

businessUnitIdstring

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

checkoutFeeIdsstring[] required

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

collectFullBillingAddressboolean required

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

collectShippingAddressboolean required

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

createdAtstring date-time

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

currencyCodestring required

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

descriptionHtmlstring

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

discountCodeEnabledboolean required

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

domainIdstring

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

formGuidstring required

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

idstring required

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

includeEmailInSuccessRedirectboolean required

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

isOneTimeUseEnabledboolean required

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

paymentLinkNamestring required

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

paymentLinkUrlstring required

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

state'OFF' | 'ON' required

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

storePaymentMethodAtCheckoutboolean required

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

successUrlstring

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

updatedAtstring date-time

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