> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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).



## OpenAPI

````yaml get /ext/v2/checkout-links/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/checkout-links/:
    get:
      tags:
        - Checkout Links
      summary: List checkout links
      description: >-
        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).
      operationId: checkout_links_list
      parameters:
        - description: When provided, filters to objects with these IDs.
          in: query
          name: ids
          required: false
          schema:
            anyOf:
              - items:
                  type: integer
                type: array
              - type: 'null'
            description: When provided, filters to objects with these IDs.
            title: Ids
        - description: >-
            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`.
          in: query
          name: ending_before
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              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`.
            title: Ending Before
        - description: >-
            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`.
          in: query
          name: starting_after
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              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`.
            title: Starting After
        - description: The maximum number of items to return per page.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: The maximum number of items to return per page.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: Required. Filters to checkout links for this clinic
          in: query
          name: clinic_id
          required: true
          schema:
            description: Required. Filters to checkout links for this clinic
            title: Clinic Id
            type: integer
        - description: When provided, filters to checkout links for this clinic client
          in: query
          name: clinic_client_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: When provided, filters to checkout links for this clinic client
            title: Clinic Client Id
        - description: >-
            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
          in: query
          name: start_date__gte
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              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
            title: Start Date  Gte
        - description: >-
            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
          in: query
          name: end_date__lte
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              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
            title: End Date  Lte
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCheckoutLinkSchemaList'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    ExternalCheckoutLinkSchemaList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalCheckoutLinkSchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: ExternalCheckoutLinkSchemaList
      type: object
    ExternalCheckoutLinkSchema:
      properties:
        acting_user:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The name of the person who sent this checkout link. If null, then
            the link was system generated.
          title: Acting User
        cart_id:
          description: The ID of the cart associated with this checkout link.
          title: Cart Id
          type: integer
        clinic_client_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: The ID of the clinic client this checkout link was sent to.
          title: Clinic Client Id
        clinic_id:
          description: The ID of the clinic for this checkout link.
          title: Clinic Id
          type: integer
        communication_methods:
          default: []
          description: The methods through which this checkout link was sent.
          items:
            type: string
          title: Communication Methods
          type: array
        id:
          description: The unique identifier for the checkout link.
          title: Id
          type: integer
        order_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: The ID of the order that was placed as a result of this checkout
          title: Order Id
        sent_at:
          description: When this checkout link was sent.
          format: date-time
          title: Sent At
          type: string
        sms_body:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The body of the SMS message sent for this checkout link, if sent via
            text.
          title: Sms Body
      required:
        - id
        - clinic_id
        - sent_at
        - cart_id
        - clinic_client_id
        - order_id
      title: ExternalCheckoutLinkSchema
      type: object
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````