Sign in

v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB
Payment Links

Update Payment Link

Updates a payment link. At least one field must be provided.

patch/v1/payment_links/{id}

Path parameters

idstring required
Example:link_12345

Payment link ID.

Headers

Authorizationstring required
Example:Basic base64(sk_live:)

The API key for authentication. Use Basic base64(sk_live:).

Request body

amountinteger

Updated amount in the smallest currency unit. Must be greater than 0.

descriptionstring

Updated description.

remarksstring

Updated remarks.

archiveboolean

Set to true to archive the payment link, or false to unarchive it.

Example request

{
  "amount": 10000,
  "description": "Test Payment Links 2",
  "remarks": "Test remarks 2",
  "archive": true
}

Response

Payment link updated successfully.

Example response

{
  "data": {
    "id": "link_12345",
    "amount": 10000,
    "currency": "PHP",
    "description": "Test Payment Links 2",
    "livemode": true,
    "remarks": "Test remarks 2",
    "status": "active",
    "url": "https://pm.link/example/aBcDe",
    "reference_number": "aBcDe",
    "metadata": {},
    "restrictions": {
      "completed_sessions": {
        "count": 1,
        "limit": 1
      }
    },
    "created_at": "2026-03-10T00:00:00Z",
    "updated_at": "2026-03-10T00:00:00Z"
  }
}