Get Payment Link
Get Payment Link
Retrieves the details of an existing payment link, including its line items and applied discounts. If the link has no label yet, one is generated from its first line item’s product and persisted before the link is returned.
GET
Get Payment Link
Authorizations
Use a Bearer token to access this API.
Path Parameters
Example:
"fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
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
}