Update Payment Link
Update Payment Link
Updates an existing payment link. Only the supplied fields are changed; omitted fields are
left unchanged. The mutable fields are label, after_completion, and active — line items,
discounts, and other parameters are fixed once the link is created. Set active to false to
archive the link, which removes it from list results and shows visitors a deactivated page.
PATCH
Update Payment Link
Authorizations
Use a Bearer token to access this API.
Path Parameters
Example:
"fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Body
application/json
An envelope wrapping a single payment link object.
An envelope wrapping a single payment link object.
The payment link.
Example:
{
"label": "Example",
"after_completion": { "type": "redirect" },
"active": false
}Response
Success
An envelope wrapping a single payment link object.
The payment link.
Example:
{
"payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"label": "Example",
"active": false,
"allow_promotion_codes": false,
"shipping_address_collection": false,
"shipping_options": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_amount": 2500,
"display_name": "Example"
},
"metadata": { "order_id": "8842", "channel": "shopify" },
"url": "https://example.com",
"created_at": "2026-06-15T14:30:00Z",
"payment_intent_data": {
"capture_method": "automatic",
"metadata": { "order_id": "8842", "channel": "shopify" }
},
"after_completion": {
"type": "redirect",
"hosted_confirmation": {},
"redirect": {}
},
"origin": "shopify",
"tax_rate": { "amount": 2500 },
"setup_future_use": "on_session",
"test_mode": false
}