Update a payment link
Update a payment link by ID.
Path parameters
The ID of the payment link to update.
Request body
An array of strings indicating the accepted payment methods. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
A boolean indicating whether automated sales tax is enabled.
An object 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 to collect the shipping address during checkout.
The currency code for the payment link, represented as a string.
An object containing deal configuration settings.
An object containing the HTML description of the payment link.
A boolean indicating whether discount codes are enabled for the payment link.
An object representing the discount object ID associated with the payment link.
An array of strings representing the IDs of discount objects associated with the payment link.
An object representing the domain ID associated with the payment link.
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.
A boolean indicating whether the payment link is enabled for one-time use.
An array of strings representing the IDs of line item objects associated with the payment link.
The name of the payment link, represented as a string.
The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'.
A boolean indicating whether the payment method should be stored at checkout.
An object representing the success URL where the user is redirected after a successful transaction.
An array of strings representing the IDs of 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.