---
title: "List all payment links"
method: GET
path: "/ext/v2/payment-links/"
tags: ["Payment Methods"]
---

# List all payment links

`GET /ext/v2/payment-links/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/payment-links/`
- Auth: HTTP bearer

Returns a list of all payment links across all clinics in the organization. The payment links are sorted by creation date, with the most recent appearing first.

A **payment link** is a URL sent to a clinic client (pet parent) to collect a specific payment amount, such as for an outstanding invoice balance.

## Query parameters

- `ids` integer[], nullable: When provided, filters to objects with these IDs.
- `ending_before` integer, nullable: A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.
- `starting_after` integer, nullable: A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.
- `limit` integer: The maximum number of items to return per page.
- `clinic_id` integer, nullable: When provided, filters payment links by clinic ID.
- `clinic_client_id` integer, nullable: When provided, filters payment links by clinic client ID.
- `is_expired` boolean, nullable: When `True`, filters to payment links that have expired, and when `False`, filters to payment links that are still active. When `None`, then both are included.
- `is_paid` boolean, nullable: When `True`, filters to payment links that have been paid, and when `False`, filters to payment links that have no been paid. When `None`, then both are included.

## Response `200`

OK

- ExternalPaymentLinkDetailSchemaList
  - `data` ExternalPaymentLinkDetailSchema[], required: A single page of data contained within this list.
    - `callback_urls` PaymentLinkCallbackUrlsSchema: Schema for payment link callback URLs
      - `on_cancel` string, nullable: Redirect URL when payment is cancelled
      - `on_success` string, nullable: Redirect URL after successful payment completion
    - `client_payment_ids` integer[]: The ID's of the client payments associated with this payment link, if any payments have been made.
    - `clinic_client_id` integer, required: The ID of the client this payment link is for.
    - `clinic_id` integer, required: The ID of the clinic this payment link is for.
    - `connect_metadata` object, nullable: Metadata to be set by the client on the payment link.
    - `custom_text` string, nullable: Optional plain-text message for the payment link. Notes written in the clinic app as rich text are flattened here; formatting and paragraph breaks are not preserved.
    - `entity_ids` integer[], required: IDs of entities to be paid based on the payment link kind: for INVOICE kind, provide one or more Invoice IDs (e.g., [123, 456]); for CARE_PLAN_PAYMENT_METHOD_UPDATE kind, provide exactly one Patient Care Plan ID (e.g., [456]).
    - `expires_on` string, date-time, required: The timestamp at which this payment link will expire.
    - `id` integer, required: The unique identifier for the payment link.
    - `is_deleted` boolean: Whether this payment link has been deleted.
    - `is_expired` boolean, required: Whether this payment link has expired.
    - `kind` 'INVOICE' | 'ESTIMATE' | 'APPOINTMENT' | 'CARE_PLAN' | 'CARE_PLAN_PAYMENT_METHOD_UPDATE', required
    - `url` string, required: The URL for the payment link.
  - `has_more` boolean: Whether there are more pages or data in this list.
  - `next_page` string, required: A URL linking to the next page of this list.
  - `type` string: Type of this object. Always `list`.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)