Create a payment link
Create a new payment link in your HubSpot account. This endpoint allows you to specify various attributes for the payment link, such as accepted payment methods, currency, and additional form fields. The payment link can be configured for one-time use and can also collect shipping and billing addresses. This operation requires a valid JSON request body. Some defaults will be applied if no value provided.
Request body
An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
A boolean indicating whether automated sales tax is enabled.
A string representing the business unit ID associated with the payment link.
A boolean indicating whether to collect the full billing address during checkout.
A boolean indicating whether the shipping address should be collected during checkout.
The currency code for the payment, represented as a string.
A string containing the HTML description of the payment link.
A boolean indicating whether discount codes are enabled for the payment link.
A string representing the object ID of a discount associated with the payment link.
An array of strings representing the IDs of discount objects associated with the payment link.
The domain ID associated with the payment link, represented as a string.
A boolean indicating whether default checkout fees are enabled.
An array of strings representing the IDs of fee objects associated with the payment link.
A boolean indicating whether to include the email in the success redirect URL.
A boolean indicating whether the payment link is enabled for one-time use.
An array of line item object IDs associated with the payment link, each represented as a string.
The name of the payment link. It is a string value.
The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'.
A boolean indicating whether to store the payment method at checkout.
A string that defines the URL to redirect to upon successful payment.
An array of string IDs representing tax objects associated with the payment link.
Response
successful operation
An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
A boolean indicating whether the payment link is archived.
The date and time when the payment link was archived, in ISO 8601 format.
A boolean indicating whether automated sales tax is enabled for the payment link.
The business unit ID associated with the payment link, represented as a string.
An array of checkout fee IDs associated with the payment link.
A boolean indicating whether to collect the full billing address during checkout.
A boolean indicating whether to collect the shipping address during checkout.
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.
The HTML description of the payment link, represented as a string.
A boolean indicating whether discount codes are enabled for the payment link.
The domain ID associated with the payment link, represented as a string.
The form GUID associated with the payment link, represented as a string.
The unique identifier for the payment link, represented as a string.
A boolean indicating whether to include the email in the success redirect URL.
A boolean indicating whether the payment link is enabled for one-time use.
The name of the payment link, represented as a string.
The URL of the payment link, represented as a string.
The current state of the payment link, represented as a string. Valid values include 'ON' and 'OFF'.
A boolean indicating whether to store the payment method at checkout.
The URL to redirect to upon successful payment, represented as a string.
The date and time when the payment link was last updated, in ISO 8601 format.