---
title: "List Paylinks"
method: GET
path: "/v1/paylinks"
tags: ["Paylinks"]
---

# List Paylinks

`GET /v1/paylinks`

The **List Paylinks** endpoint allows you to retrieve a comprehensive list of all pay links created within your organization on the BoomFi platform. Use this endpoint to efficiently manage and review all the payment links you have generated, ensuring they align with your business needs.

> 📘 Note
> 
> Paylinks are created automatically when a plan is created. Each plan has a corresponding paylink that can be used to facilitate payments.

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `page` integer
- `since` string
- `sort` 'asc' | 'desc'
- `until` string

## Response `200`

OK

- InternalPaginatedResponsePaylinksPaymentLinkResponse
  - `data` InternalPaginatedItemsPaylinksPaymentLinkResponse
    - `items` PaylinksPaymentLinkResponse[]
      - `id` string — The unique identifier for the paylink
      - `plan_id` string — The ID of the associated plan
      - `invoice_id` string — The ID of the associated invoice
      - `source` string — The source of the paylink
      - `customer_ident_collection` boolean — Indicates if customer identification collection is enabled
      - `shipping_address_collection` boolean — Indicates if shipping address collection is enabled
      - `tax_ident_collection` boolean — Indicates if tax identification collection is enabled
      - `enabled` boolean — Indicates if the paylink is enabled
      - `deleted_at` string, date-time — The timestamp when the paylink was deleted
      - `created_by` string — The ID of the user who created the paylink
      - `updated_by` string — The ID of the user who last updated the paylink
      - `created_at` string, date-time — The timestamp when the paylink was created
      - `updated_at` string, date-time — The timestamp when the paylink was last updated
      - `available_quantity` number — The remaining number of times this payment link can be used. `null` indicates unlimited usage. - Decremented on each successful or failed payment. - Restored when a payment is canceled. - When the value reaches zero, the payment link becomes invalid.
      - `expires_at` string, date-time — The expiration date and time of the payment link. Any checkout attempt after this timestamp will fail.
      - `metadata` object — Additional metadata associated with the paylink
      - `properties` object — Additional properties associated with the paylink
        - `short_code` string — The short code associated with the paylink
      - `plan` object — The details of the associated plan
        - `id` string — The unique identifier for the plan
        - `org_id` string — The organization ID associated with the plan
        - `source` string — The source of the plan
        - `name` string — The name of the plan
        - `type` string — The type of the plan
        - `billing_scheme` string — The billing scheme of the plan
        - `price` string — The price of the plan
        - `currency` string — The currency of the plan
        - `available_quantity` integer — The available quantity of the plan
        - `trial_period` string — The trial period of the plan
        - `recurring_interval` string — The recurring interval of the plan
        - `recurring_interval_count` integer — The recurring interval count of the plan
        - `recurring_usage_type` string — The recurring usage type of the plan
        - `reference` string — The reference of the plan
        - `enabled` boolean — Indicates if the plan is enabled
        - `v1` string — Additional information about the plan
        - `created_by` string — The ID of the user who created the plan
        - `created_at` string, date-time — The timestamp when the plan was created
        - `updated_at` string, date-time — The timestamp when the plan was last updated
        - `deleted_at` string, date-time — The timestamp when the plan was deleted
        - `metadata` object — Additional metadata associated with the plan
    - `last_update` string — The timestamp indicating when the data was last updated.
    - `next` integer — The index of the next page of paylinks.
    - `total` integer — The total number of paylinks available.
  - `error` boolean

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

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