NEnexhealth
Payment Plans

View payment plan (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data.guarantor.address, data.guarantor.address.city, data.guarantor.address.line_1, data.guarantor.address.line_2 (+30 more); and other schema changes.

This endpoint returns a single payment plan by its NexHealth ID, optionally including the associated patient and guarantor.

get/payment_plans/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/payment_plans/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

NexHealth ID of the payment plan

Query parameters

include[]string[]

Resources to be included in the response

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 113,
    "patient_id": 115,
    "guarantor_id": 115,
    "first_payment_due_date": "2020-06-05",
    "created_date": "2020-06-05",
    "patient": {
      "id": 415,
      "email": "anthony.smith@nexhealth.com",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 1,
      "foreign_id": "532e7f8c",
      "foreign_id_type": "--DataSource-",
      "cell_phone_number": "5163042196",
      "preferred_phone_number": "5163042196",
      "billing_type": "Standard Billing - finance charges",
      "chart_id": "017407",
      "preferred_language": "es",
      "gender": "Female",
      "non_patient": true,
      "date_of_birth": "1964-05-03",
      "address": {
        "line_1": "333 Bush Street",
        "line_2": "Apt 4B",
        "postal_code": "20814",
        "city": "New York",
        "region": "NY"
      }
    },
    "guarantor": {
      "id": 415,
      "email": "anthony.smith@nexhealth.com",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 1,
      "foreign_id": "532e7f8c",
      "foreign_id_type": "--DataSource-",
      "cell_phone_number": "5163042196",
      "preferred_phone_number": "5163042196",
      "billing_type": "Standard Billing - finance charges",
      "chart_id": "017407",
      "preferred_language": "es",
      "gender": "Female",
      "non_patient": true,
      "date_of_birth": "1964-05-03",
      "address": {
        "line_1": "333 Bush Street",
        "line_2": "Apt 4B",
        "postal_code": "20814",
        "city": "New York",
        "region": "NY"
      }
    }
  },
  "count": 2
}

Changes

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