---
title: "List Payment Link Usages"
method: GET
path: "/payment-links/v1/{payment_link_id}/usages"
tags: ["Payment Links"]
---

# List Payment Link Usages

`GET /payment-links/v1/{payment_link_id}/usages`

Returns a paginated list of usages for a given payment link.

## Path parameters

- `payment_link_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer

## Response `200`

Paginated list of payment link usages returned.

- PaymentLinkUsageList — A single page of payment link usages. Use the page object for total counts and paginate with the page and size query parameters.
  - `content` PaymentLinkUsageDetails[], required — List of payment link usages for the current page
    - `usage_id` string, uuid, required — Unique identifier of this usage.
    - `payment_link_id` string, uuid, required — Identifier of the payment link that was used.
    - `usage_status` 'STARTED' | 'PAYMENT_CREATED' | 'FAILED' | 'EXPIRED', required — Lifecycle status of the payment link usage. - `STARTED`: Payment flow initiated; payment intent created; waiting for bank confirmation. - `PAYMENT_CREATED`: Bank confirmed the payment was accepted or is pending. - `FAILED`: Bank rejected the payment or an error occurred during processing. - `EXPIRED`: Usage remained in `STARTED` for more than 30 minutes and was cleaned up by the system.
    - `customer_id` string, uuid, nullable — Identifier of the customer record created or matched for this payer.
    - `payment_id` string, uuid, nullable — Identifier of the payment created for this usage. `null` until the bank has confirmed or rejected the payment submission.
    - `payment_status` string, nullable — Status of the underlying payment as last reported by the bank. `null` until the payment has been created. Refer to the Lean Payments API documentation for the full list of payment status values.
    - `identifiers` CollectedIdentifier[], required — Identifiers collected from the payer during the payment flow, in the order they were defined on the payment link. Empty when no identifiers were configured.
      - `type` 'EMAIL' | 'MOBILE_PHONE' | 'TEXT', required — The type of information to collect from the payer. Controls input validation and formatting in the payment UI. - EMAIL: Collects an email address. Input is validated against standard email format. - MOBILE_PHONE: Collects a mobile phone number. Input is validated as a valid phone number. - TEXT: Collects a free-form text value. Use the limit field to constrain length.
      - `display_label` string, required — Human-readable label shown to the payer when collecting this identifier.
      - `value` string, required — The value entered by the payer.
  - `page` PageMetadata, required — Metadata about the current page of results
    - `number` integer, required — The current page being returned by the API
    - `size` integer, required — The page size requested
    - `total_elements` integer, required — The total number of elements in all pages
    - `total_pages` integer, required — The total number of pages retrievable
    - `sort` string[] — Sort parameters applied to the results

---

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