Retrieve a 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.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the payment link to retrieve.
Query Parameters
Whether to return only results that have been archived. Defaults to false.
Response
successful operation
An array of accepted payment methods for the link, which can include 'CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
CARD, ACH, SEPA, BACS, PADS An array of additional form fields included in the payment link.
A boolean indicating if the payment link is archived.
A boolean indicating if automated sales tax calculation is enabled.
An array of strings representing the IDs of checkout fees associated with the payment link.
A boolean indicating if the full billing address should be collected during checkout.
A boolean indicating if the shipping address should be collected during checkout.
A string representing the date and time when the payment link was created, in ISO 8601 format.
The currency code for the payment link, represented as a string.
A boolean indicating if discount codes are enabled for the payment link.
An array of discount objects associated with the payment link.
An array of fee objects associated with the payment link.
A string representing the form GUID associated with the payment link.
A string representing the unique identifier of the payment link.
A boolean indicating if the email should be included in the success redirect.
A boolean indicating if the payment link is enabled for one-time use only.
An array of line items associated with the payment link.
The name of the payment link, represented as a string.
A string representing the URL of the payment link.
The current state of the payment link, which can be either 'ON' or 'OFF'.
OFF, ON A boolean indicating if the payment method should be stored at checkout.
An array of tax objects associated with the payment link.
A string representing the date and time when the payment link was last updated, in ISO 8601 format.
A string representing the date and time when the payment link was archived, in ISO 8601 format.
A string representing the business unit ID associated with the payment link.
A string containing the HTML description of the payment link.
A string representing the domain ID associated with the payment link.
A string representing the URL to redirect to upon successful payment.