v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Payment Links

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 makes checkout session generation from the link return a 404. Set active back to true to restore it.

patch/v1/payment_links/{id}

Path parameters

idstring required

Example:fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Request body

Example request

{
  "payment_link": {
    "label": "Example",
    "after_completion": {},
    "active": false
  }
}

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
  }
}