Payment plans

Before you start

• NexHealth reads financial data from the health record system only on request. To turn it on for your API key, email [email protected]. Sandbox locations have it on.
• Every request needs a bearer token from POST /authenticates. See Authentication.
• Requests take the practice's subdomain and, for most endpoints, a location_id. See Institutions, syncs, and locations.

Overview

Payment plans let a practice split a patient's balance into scheduled payments over time. They help patients manage large bills by spreading payments across several months. The endpoint returns the first payment due date and whether the plan is still active.

Not every practice stores payment plan details in its health record system. Some use third-party services like CareCredit to manage plans separately. If a practice uses an outside provider, this endpoint may not have its payment plans.

🚧

Limited information

Today this endpoint does not return the full payment schedule, such as installment amounts and expected payment dates. It only gives you the first payment due date and whether the plan is still active.

📘

Review payment plans before sending balance requests

Before you request payments, check whether the patient started a payment plan in the past 18 months. If they did, do not send automatic payment requests. Review them manually first.

Example use cases

• Use payment plan information to make sure patient payment requests are accurate.

Payment plans response

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
    "id": 113,
    "patient_id": 115,
    "guarantor_id": 115,
    "first_payment_due_date": "2020-06-05",
    "created_date": "2020-06-05",
    "active": true,
    "patient": {
      ...
    },
    "guarantor": {
      ...
    }
  },
  "count": null
}