VEvetcove
Payment Methods

Fetch a payment link

Fetches a payment link by its ID.

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/{payment_link_id}/

Request

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

Path parameters

payment_link_idinteger required

The ID of the payment link to fetch

Response

OK

client_payment_idsinteger[]

The ID's of the client payments associated with this payment link, if any payments have been made.

clinic_client_idinteger required

The ID of the client this payment link is for.

clinic_idinteger required

The ID of the clinic this payment link is for.

connect_metadataobject nullable

Metadata to be set by the client on the payment link.

custom_textstring 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_idsinteger[] 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_onstring date-time required

The timestamp at which this payment link will expire.

idinteger required

The unique identifier for the payment link.

is_deletedboolean

Whether this payment link has been deleted.

is_expiredboolean required

Whether this payment link has expired.

kind'INVOICE' | 'ESTIMATE' | 'APPOINTMENT' | 'CARE_PLAN' | 'CARE_PLAN_PAYMENT_METHOD_UPDATE' required
urlstring required

The URL for the payment link.

Changes

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