Checkout
UpdatePaymentLink
Updates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data. You cannot update other fields such as the order_id, version, URL, or timestamp field.
put/v2/online-checkout/payment-links/{id}
Path parameters
idstring required
The ID of the payment link to update.
Request body
Example request
{
"payment_link": {
"checkout_options": {
"ask_for_shipping_address": true
},
"version": 1
}
}Response
Success
Example response
{
"payment_link": {
"checkout_options": {
"ask_for_shipping_address": true
},
"created_at": "2022-04-26T00:15:15Z",
"id": "TY4BWEDJ6AI5MBIV",
"long_url": "https://checkout.square.site/EXAMPLE",
"order_id": "Qqc8ypQGvxVwc46Cch4zHTaJqc4F",
"payment_note": "test",
"updated_at": "2022-04-26T00:18:24Z",
"url": "https://square.link/u/EXAMPLE",
"version": 2
}
}