---
title: "Archive a payment link"
method: PATCH
path: "/api/link/{id}/archive"
tags: ["Links"]
---

# Archive a payment link

`PATCH /api/link/{id}/archive`

Archives a payment link. Archiving also disables the link for checkout.

## Path parameters

- `id` string, required

## Response `200`

Payment link archived successfully

- ApiLinkDto
  - `id` string, required — The unique identifier of the link
  - `name` string, required — The name of the link
  - `amount` number, required — The total amount of the link in cents
  - `currency` 'EUR' | 'GBP' | 'USD', required — The currency of the link
  - `status` 'enabled' | 'disabled', required — The status of the link
  - `isArchived` boolean, required — Whether the payment link is archived
  - `products` object[], required — The list of products included in this link
    - `name` string
    - `price` number
    - `quantity` number
  - `paymentIds` string[], required — The list of payment IDs associated with this link
  - `sessionCustomization` SessionCustomizationDto, required
    - `bgColor` string, nullable — Background color for the payment session
    - `fontColor` string, nullable — Font color for the payment session
    - `logoUrl` string, nullable — Logo URL for the payment session
    - `merchantName` string, nullable — Merchant name for the payment session
  - `paymentLinkUrl` string, required — The URL to access the payment link
  - `statementDescriptor` string, nullable — Optional statement descriptor (max 11 characters) shown on the customer's bank statement
  - `createdAt` string, date-time, required — The creation date of the link
  - `updatedAt` string, date-time, required — The last update date of the link

---

[API](https://skmtc.dev/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.dev/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/revisions/3012dd3dd14a/schema)