VEvetcove
Care Plans

Import or update a legacy patient care plan

Imports or updates a legacy patient care plan for a clinic patient.

If an existing patient care plan for the same PIM patient ID and core Care Plan ID already exists and has a status of IMPORTED, it will be updated instead. Patient care plans with any other status, including imported patient care plans that have already been marked ACTIVE, cannot be updated through this endpoint.

post/ext/v2/patient-care-plans/import/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/patient-care-plans/import/
  • Auth
    HTTP bearer

Request body

amount_paidinteger required

The amount paid for the care plan

care_plan_idinteger required

The core Care Plan ID to enroll the patient into

clinic_client_idinteger nullable

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_idinteger required

The clinic ID for the patient and client being imported

clinic_patient_idinteger nullable

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.

end_datestring 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_feeinteger required

The enrollment fee of the care plan

is_billed_monthlyboolean required

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

next_plan_idinteger nullable

Optional next core Care Plan ID for automatic renewal

payment_method_idinteger nullable

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.

pim_client_idstring required

The PIM client ID to import the care plan for

pim_patient_idstring required

The PIM patient ID to import the care plan for

plan_costinteger required

The cost of the care plan

should_renewboolean required

Whether the plan should automatically renew at the end of term

start_datestring date required

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

status'IMPORTED' | 'CLIENT_CREATED' | 'CLINIC_CREATED' | 'ACTIVE' | 'TERMINATED' | 'PAYMENT_FAILED' | 'SUSPENDED' required
stripe_payment_method_idstring nullable

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

OK

care_plan_idinteger required

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

care_plan_kind'CORE' | 'ADD_ON' | 'SERVICE_PACKAGE' required
care_plan_namestring required

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

clinic_client_idinteger required

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

clinic_idinteger required

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

clinic_patient_idinteger required

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

core_plan_idinteger nullable required

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

deactivated_atstring date-time nullable required

When this care plan was deactivated, if applicable

deactivated_bystring nullable required

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

end_datestring 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_feeinteger required

The enrollment fee of the care plan

idinteger required

The unique identifier for the patient care plan

is_billed_monthlyboolean required

Whether the care plan is billed monthly or upfront

monthly_costinteger nullable required

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

next_payment_datestring date nullable required

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

next_plan_idinteger nullable required

The ID of the next care plan, if applicable

payment_method_idinteger nullable required

The ID of the payment method associated with this care plan

plan_costinteger required

The cost of the care plan

remaining_balanceinteger required

The remaining balance of the care plan, in cents

should_renewboolean required

Whether this care plan will automatically be renewed

start_datestring date required

The start date of the care plan

Changes

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