Patient care plans

List a patient's current care plan benefit redemptions

Returns benefit redemptions for a clinic patient’s current care plan enrollment: the core plan, its add-ons, and its service packages.

A care plan benefit is an allowance on that enrollment: a pool of points, unlimited included services, or a percent discount. A redemption is one use of that benefit, either on an invoice line or imported without one. Each benefit shows how much has been used, how much remains, and the uses that still count.

GET

ext

patient-care-plans

benefit-redemptions

List a patient's current care plan benefit redemptions

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "benefits": [
        {
          "care_benefit_id": 123,
          "discount_percent": "<string>",
          "id": 123,
          "kind": "UNLIMITED",
          "name": "<string>",
          "points_remaining": 123,
          "points_used": 123,
          "redemptions": [
            {
              "amount_discounted": 123,
              "created": "2023-11-07T05:31:56Z",
              "id": 123,
              "invoice_item": {
                "id": 123,
                "line_display": "<string>",
                "quantity_rendered": 123
              },
              "points_redeemed": 123
            }
          ],
          "total_points": 123,
          "total_savings": 123
        }
      ],
      "care_plan_id": 123,
      "care_plan_kind": "CORE",
      "care_plan_name": "<string>",
      "id": 123
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

clinic_patient_id

integer

required

The ID of the patient to fetch the current care plan for

Response

200 - application/json

data

ExternalPatientCarePlanWithRedemptionsSchema · object[]

required

A single page of data contained within this list.

Show child attributes

next_page

string

required

A URL linking to the next page of this list.

has_more

boolean

default:false

Whether there are more pages or data in this list.

type

string

default:list

Type of this object. Always list.

⌘I

List a patient's current care plan benefit redemptions

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/patient-care-plans/benefit-redemptions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "benefits": [
        {
          "care_benefit_id": 123,
          "discount_percent": "<string>",
          "id": 123,
          "kind": "UNLIMITED",
          "name": "<string>",
          "points_remaining": 123,
          "points_used": 123,
          "redemptions": [
            {
              "amount_discounted": 123,
              "created": "2023-11-07T05:31:56Z",
              "id": 123,
              "invoice_item": {
                "id": 123,
                "line_display": "<string>",
                "quantity_rendered": 123
              },
              "points_redeemed": 123
            }
          ],
          "total_points": 123,
          "total_savings": 123
        }
      ],
      "care_plan_id": 123,
      "care_plan_kind": "CORE",
      "care_plan_name": "<string>",
      "id": 123
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Incentives

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

List a patient's current care plan benefit redemptions

Authorizations

Query Parameters

Response