VEvetcove
Payment Methods

List all payment links

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.

get/ext/v2/payment-links/

Request

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

Query parameters

idsinteger[] nullable

When provided, filters to objects with these IDs.

ending_beforeinteger 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_afterinteger 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.

limitinteger

The maximum number of items to return per page.

clinic_idinteger nullable

When provided, filters payment links by clinic ID.

clinic_client_idinteger nullable

When provided, filters payment links by clinic client ID.

is_expiredboolean 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_paidboolean 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

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.