---
title: "Update Payment Link"
method: PATCH
path: "/v1/payment_links/{id}"
tags: ["Payment Links"]
---

# Update Payment Link

`PATCH /v1/payment_links/{id}`

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

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required

## Request body

- object — At least one field must be provided.
  - `amount` integer — Updated amount in the smallest currency unit. Must be greater than 0.
  - `description` string — Updated description.
  - `remarks` string — Updated remarks.
  - `archive` boolean — Set to true to archive the payment link, or false to unarchive it.

## Response `200`

Payment link updated successfully.

- object
  - `data` object
    - `id` string, required — The unique identifier of the payment link.
    - `amount` integer, required — Amount in the smallest currency unit.
    - `currency` string, required — Three-letter ISO currency code.
    - `description` string — Description of the payment link. Omitted if not set.
    - `livemode` boolean, required — Indicates whether the payment link is live.
    - `remarks` string — Remarks attached to the payment link. Omitted if not set.
    - `status` 'active' | 'archived', required — Status of the payment link.
    - `url` string, required — Checkout URL of the payment link.
    - `reference_number` string, required — Reference number associated with the payment link.
    - `metadata` object, required — Additional metadata.
    - `restrictions` object — Completion restrictions for the payment link. Omitted if not configured.
      - `completed_sessions` object
        - `count` integer — Number of completed sessions.
        - `limit` integer — Maximum allowed completed sessions.
    - `created_at` string, date-time, required — Creation timestamp in ISO 8601 format.
    - `updated_at` string, date-time, required — Last update timestamp in ISO 8601 format.

## Other responses

- `400` — Bad request. Returned when the request body is invalid or no fields are provided.
- `401` — Unauthorized.
- `404` — Payment link not found.
- `500` — Internal server error.

---

[API](https://skmtc.net/paymongo/apis/paymongo-api.md) · [All operations](https://skmtc.net/paymongo/apis/paymongo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymongo/paymongo-api/revisions/c18f9a027b2c/schema)