v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Payment Links

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/v1/payment_links/{id}

Path parameters

idstring required

Example:fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Response

An envelope wrapping a single payment link object.

Example response

{
  "payment_link": {
    "payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "label": "Example",
    "active": false,
    "allow_promotion_codes": false,
    "shipping_address_collection": false,
    "shipping_options": {},
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "url": "https://example.com",
    "created_at": "2026-06-15T14:30:00Z",
    "payment_intent_data": {},
    "after_completion": {},
    "origin": "shopify",
    "tax_rate": {},
    "setup_future_use": "on_session",
    "test_mode": false
  }
}