WIwithflex
Payment Links

Update Payment Link

Changed on

Updates an existing payment link. Only the supplied fields are changed; omitted fields are left unchanged. The mutable fields are the label, the after-completion behavior, the active flag, and shipping address collection — 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}

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/payment_links/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Request body

Example request

{
  "payment_link": {
    "label": "Example",
    "after_completion": {
      "type": "redirect",
      "hosted_confirmation": {
        "custom_message": "Premium SPF 50 mineral sunscreen"
      },
      "redirect": {
        "url": "https://example.com"
      }
    },
    "active": false,
    "shipping_address_collection": false
  }
}

Response

An envelope wrapping a single payment link object.

Example response

{
  "payment_link": {
    "payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "label": "Example",
    "active": false,
    "line_items": [
      {
        "price": "fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
        "price_data": {
          "description": "Premium SPF 50 mineral sunscreen",
          "unit_amount": 2500,
          "recurring": {
            "interval": "day",
            "interval_count": 0,
            "trial_period_days": 0
          },
          "metadata": {
            "order_id": "8842",
            "channel": "shopify"
          },
          "product": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
          "product_data": {
            "name": "Example",
            "description": "Premium SPF 50 mineral sunscreen",
            "upc_code": "example_value",
            "gtin": "example_value",
            "reference_gtin": "example_value",
            "url": "https://example.com",
            "client_reference_id": "example_value",
            "metadata": {
              "order_id": "8842",
              "channel": "shopify"
            },
            "image_urls": [
              "https://example.com/image.png"
            ],
            "categories": [
              "string"
            ],
            "components": [
              "string"
            ]
          }
        },
        "quantity": 0,
        "shipping_options": {
          "shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
          "shipping_rate_data": {
            "display_name": "Example",
            "amount": 2500,
            "metadata": {
              "order_id": "8842",
              "channel": "shopify"
            }
          }
        },
        "tax_rate": {
          "amount": 2500
        },
        "components": [
          {
            "quantity": 1,
            "dressing_mode": "MIXED",
            "component_id": "fcomp_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
            "client_reference_id": "string"
          }
        ]
      }
    ],
    "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": {
        "custom_message": "Premium SPF 50 mineral sunscreen"
      },
      "redirect": {
        "url": "https://example.com"
      }
    },
    "origin": "shopify",
    "tax_rate": {
      "amount": 2500
    },
    "discounts": [
      "fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    ],
    "setup_future_use": "on_session",
    "test_mode": false
  }
}

Changes

  • eec642897a22Revision changes
    • warning

      added the new renewal enum value to the ///// response property for the response status

    • info

      added the new optional request property /

    • info

      added the optional property /// to the response with the status

    • info

      added to the /// response property anyOf list for the response status

    • info

      removed from the /// response property anyOf list for the response status