API Reference

Payment Plans

This endpoint is in beta and as such all content below is subject to change.

🚧

Supported Integrations

For now, payment plans are supported for OpenDental, Dentrix, Dentrix Enterprise and Eaglesoft.

Payment plans allow patients to pay for services in installments over time.

This endpoint returns information about payment plans that exist in patients’ health record system profiles. It is important to note that not all practices store information about a patient's payment plan in their health record system. Some practices have agreements with third parties (like CareCredit) who store and manage the plan independently.

Payment Plans Response Object

{
  "code": false,
  "description": "Description",
  "error": "Error",
  "data": [
    {
      "id": 113,
      "patient_id": 115,
      "guarantor_id": 115,
      "first_payment_due_date": "2020-06-05",
      "created_date": "2020-06-05",
      "active": true
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}