VEvetcove
Checkout Links

List checkout links

Returns a list of checkout links for a clinic. The checkout links are sorted by creation date, with the most recent appearing first.

A checkout link is a unique URL sent to a pet parent (clinic client) that allows them to complete a purchase online. Each checkout link is associated with a specific clinic and client, and tracks whether the link has been opened and the communication method used to deliver it (e.g., SMS, email).

get/ext/v2/checkout-links/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/checkout-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 required

Required. Filters to checkout links for this clinic

clinic_client_idinteger nullable

When provided, filters to checkout links for this clinic client

start_date__gtestring nullable

When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD

end_date__ltestring nullable

When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD

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.