Import or update a legacy patient care plan

POST

ext

patient-care-plans

import

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/import/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_paid": 1,
  "care_benefits": [
    {
      "care_benefit_id": 123,
      "redemptions": [
        {
          "amount_discounted": 1,
          "points_redeemed": 1
        }
      ],
      "points_used": 1
    }
  ],
  "care_plan_id": 123,
  "clinic_id": 123,
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "is_billed_monthly": true,
  "pim_client_id": "<string>",
  "pim_patient_id": "<string>",
  "plan_cost": 1,
  "should_renew": true,
  "start_date": "2023-12-25",
  "clinic_client_id": 123,
  "clinic_patient_id": 123,
  "next_plan_id": 123,
  "payment_method_id": 123,
  "stripe_payment_method_id": "<string>"
}
'

import requests

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

payload = {
    "amount_paid": 1,
    "care_benefits": [
        {
            "care_benefit_id": 123,
            "redemptions": [
                {
                    "amount_discounted": 1,
                    "points_redeemed": 1
                }
            ],
            "points_used": 1
        }
    ],
    "care_plan_id": 123,
    "clinic_id": 123,
    "end_date": "2023-12-25",
    "enrollment_fee": 1,
    "is_billed_monthly": True,
    "pim_client_id": "<string>",
    "pim_patient_id": "<string>",
    "plan_cost": 1,
    "should_renew": True,
    "start_date": "2023-12-25",
    "clinic_client_id": 123,
    "clinic_patient_id": 123,
    "next_plan_id": 123,
    "payment_method_id": 123,
    "stripe_payment_method_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount_paid: 1,
    care_benefits: [
      {
        care_benefit_id: 123,
        redemptions: [{amount_discounted: 1, points_redeemed: 1}],
        points_used: 1
      }
    ],
    care_plan_id: 123,
    clinic_id: 123,
    end_date: '2023-12-25',
    enrollment_fee: 1,
    is_billed_monthly: true,
    pim_client_id: '<string>',
    pim_patient_id: '<string>',
    plan_cost: 1,
    should_renew: true,
    start_date: '2023-12-25',
    clinic_client_id: 123,
    clinic_patient_id: 123,
    next_plan_id: 123,
    payment_method_id: 123,
    stripe_payment_method_id: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/import/', 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/import/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount_paid' => 1,
    'care_benefits' => [
        [
                'care_benefit_id' => 123,
                'redemptions' => [
                                [
                                                                'amount_discounted' => 1,
                                                                'points_redeemed' => 1
                                ]
                ],
                'points_used' => 1
        ]
    ],
    'care_plan_id' => 123,
    'clinic_id' => 123,
    'end_date' => '2023-12-25',
    'enrollment_fee' => 1,
    'is_billed_monthly' => true,
    'pim_client_id' => '<string>',
    'pim_patient_id' => '<string>',
    'plan_cost' => 1,
    'should_renew' => true,
    'start_date' => '2023-12-25',
    'clinic_client_id' => 123,
    'clinic_patient_id' => 123,
    'next_plan_id' => 123,
    'payment_method_id' => 123,
    'stripe_payment_method_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/patient-care-plans/import/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}"

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

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

{
  "error": {
    "details": {
      "candidates": [
        {
          "id": 123,
          "name": "<string>",
          "was_imported_from_legacy_source": true
        }
      ],
      "resolution_field": "clinic_patient_id"
    },
    "message": "<string>",
    "type": "disambiguation_required"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Schema for importing a legacy patient care plan via the external API.

amount_paid

integer

required

The amount paid for the care plan

Required range: x >= 0

care_benefits

ExternalLegacyPatientCareBenefitImportSchema · object[]

required

The care benefits to import for the care plan

Show child attributes

care_plan_id

integer

required

The core Care Plan ID to enroll the patient into

clinic_id

integer

required

The clinic ID for the patient and client being imported

end_date

string<date>

required

End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.

enrollment_fee

integer

required

The enrollment fee of the care plan

Required range: x >= 0

is_billed_monthly

boolean

required

Whether billing is monthly (True) or upfront (False)

pim_client_id

string

required

The PIM client ID to import the care plan for

pim_patient_id

string

required

The PIM patient ID to import the care plan for

plan_cost

integer

required

The cost of the care plan

Required range: x >= 0

should_renew

boolean

required

Whether the plan should automatically renew at the end of term

start_date

string<date>

required

Start date for the enrollment (YYYY-MM-DD)

status

enum<string>

required

The status of the care plan. Must be one of: IMPORTED, ACTIVE, TERMINATED

Available options:

IMPORTED,

CLIENT_CREATED,

CLINIC_CREATED,

ACTIVE,

TERMINATED,

PAYMENT_FAILED,

SUSPENDED

clinic_client_id

integer | null

Optional Vetcove client ID. When provided, bypasses PIM ID lookup and resolves the client by primary key (scoped to clinic). Use this to disambiguate when multiple clients share the same pim_client_id.

clinic_patient_id

integer | null

Optional Vetcove patient ID. When provided, bypasses PIM ID lookup and resolves the patient by primary key (scoped to clinic). Use this to disambiguate when multiple patients share the same pim_patient_id.

next_plan_id

integer | null

Optional next core Care Plan ID for automatic renewal

payment_method_id

integer | null

Optional Vetcove payment method ID. When provided, takes precedence over stripe_payment_method_id and resolves the payment method by primary key (scoped to the client). Both payment method fields are optional for all statuses. Omitting both means the payment method must be updated later before billing.

stripe_payment_method_id

string | null

Optional legacy Stripe payment method ID to use for billing. payment_method_id takes precedence when both fields are provided. Both payment method fields are optional for all statuses. Omitting both means the payment method must be updated later before billing.

Response

care_plan_id

integer

required

The ID of the Care Plan this patient-specific plan is linked to

care_plan_kind

enum<string>

required

The type of the care plan

Available options:

CORE,

ADD_ON,

SERVICE_PACKAGE

care_plan_name

string

required

The name of the care plan this patient care plan is linked to

clinic_client_id

integer

required

The ID of the clinic client this patient care plan is associated with

clinic_id

integer

required

The ID of the clinic this patient care plan is associated with

clinic_patient_id

integer

required

The ID of the clinic patient this care plan is associated with

core_plan_id

integer | null

required

The ID of the core patient care plan this one is linked to, if this is an add-on plan

deactivated_at

string<date-time> | null

required

When this care plan was deactivated, if applicable

deactivated_by

string | null

required

The name of the user who deactivated the care plan, if applicable

end_date

string<date>

required

End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.

enrollment_fee

integer

required

The enrollment fee of the care plan

Required range: x >= 0

integer

required

The unique identifier for the patient care plan

is_billed_monthly

boolean

required

Whether the care plan is billed monthly or upfront

monthly_cost

integer | null

required

The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.

Required range: x >= 0

next_payment_date

string<date> | null

required

The date of the next payment for the care plan, if applicable

next_plan_id

integer | null

required

The ID of the next care plan, if applicable

payment_method_id

integer | null

required

The ID of the payment method associated with this care plan

plan_cost

integer

required

The cost of the care plan

Required range: x >= 0

remaining_balance

integer

required

The remaining balance of the care plan, in cents

should_renew

boolean

required

Whether this care plan will automatically be renewed

start_date

string<date>

required

The start date of the care plan

status

required

The status of the patient care plan

Available options:

IMPORTED,

CLIENT_CREATED,

CLINIC_CREATED,

ACTIVE,

TERMINATED,

PAYMENT_FAILED,

SUSPENDED

⌘I

Import or update a legacy patient care plan

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/import/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_paid": 1,
  "care_benefits": [
    {
      "care_benefit_id": 123,
      "redemptions": [
        {
          "amount_discounted": 1,
          "points_redeemed": 1
        }
      ],
      "points_used": 1
    }
  ],
  "care_plan_id": 123,
  "clinic_id": 123,
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "is_billed_monthly": true,
  "pim_client_id": "<string>",
  "pim_patient_id": "<string>",
  "plan_cost": 1,
  "should_renew": true,
  "start_date": "2023-12-25",
  "clinic_client_id": 123,
  "clinic_patient_id": 123,
  "next_plan_id": 123,
  "payment_method_id": 123,
  "stripe_payment_method_id": "<string>"
}
'

import requests

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

payload = {
    "amount_paid": 1,
    "care_benefits": [
        {
            "care_benefit_id": 123,
            "redemptions": [
                {
                    "amount_discounted": 1,
                    "points_redeemed": 1
                }
            ],
            "points_used": 1
        }
    ],
    "care_plan_id": 123,
    "clinic_id": 123,
    "end_date": "2023-12-25",
    "enrollment_fee": 1,
    "is_billed_monthly": True,
    "pim_client_id": "<string>",
    "pim_patient_id": "<string>",
    "plan_cost": 1,
    "should_renew": True,
    "start_date": "2023-12-25",
    "clinic_client_id": 123,
    "clinic_patient_id": 123,
    "next_plan_id": 123,
    "payment_method_id": 123,
    "stripe_payment_method_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount_paid: 1,
    care_benefits: [
      {
        care_benefit_id: 123,
        redemptions: [{amount_discounted: 1, points_redeemed: 1}],
        points_used: 1
      }
    ],
    care_plan_id: 123,
    clinic_id: 123,
    end_date: '2023-12-25',
    enrollment_fee: 1,
    is_billed_monthly: true,
    pim_client_id: '<string>',
    pim_patient_id: '<string>',
    plan_cost: 1,
    should_renew: true,
    start_date: '2023-12-25',
    clinic_client_id: 123,
    clinic_patient_id: 123,
    next_plan_id: 123,
    payment_method_id: 123,
    stripe_payment_method_id: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/import/', 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/import/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount_paid' => 1,
    'care_benefits' => [
        [
                'care_benefit_id' => 123,
                'redemptions' => [
                                [
                                                                'amount_discounted' => 1,
                                                                'points_redeemed' => 1
                                ]
                ],
                'points_used' => 1
        ]
    ],
    'care_plan_id' => 123,
    'clinic_id' => 123,
    'end_date' => '2023-12-25',
    'enrollment_fee' => 1,
    'is_billed_monthly' => true,
    'pim_client_id' => '<string>',
    'pim_patient_id' => '<string>',
    'plan_cost' => 1,
    'should_renew' => true,
    'start_date' => '2023-12-25',
    'clinic_client_id' => 123,
    'clinic_patient_id' => 123,
    'next_plan_id' => 123,
    'payment_method_id' => 123,
    'stripe_payment_method_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/patient-care-plans/import/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount_paid\": 1,\n  \"care_benefits\": [\n    {\n      \"care_benefit_id\": 123,\n      \"redemptions\": [\n        {\n          \"amount_discounted\": 1,\n          \"points_redeemed\": 1\n        }\n      ],\n      \"points_used\": 1\n    }\n  ],\n  \"care_plan_id\": 123,\n  \"clinic_id\": 123,\n  \"end_date\": \"2023-12-25\",\n  \"enrollment_fee\": 1,\n  \"is_billed_monthly\": true,\n  \"pim_client_id\": \"<string>\",\n  \"pim_patient_id\": \"<string>\",\n  \"plan_cost\": 1,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"next_plan_id\": 123,\n  \"payment_method_id\": 123,\n  \"stripe_payment_method_id\": \"<string>\"\n}"

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

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

{
  "error": {
    "details": {
      "candidates": [
        {
          "id": 123,
          "name": "<string>",
          "was_imported_from_legacy_source": true
        }
      ],
      "resolution_field": "clinic_patient_id"
    },
    "message": "<string>",
    "type": "disambiguation_required"
  }
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Import or update a legacy patient care plan

Authorizations

Body

Response