--- title: "View payment plan (beta)" method: GET path: "/payment_plans/{id}" tags: ["Payment Plans"] --- # View payment plan (beta) `GET /payment_plans/{id}` ## Request - Base URL: `https://nexhealth.info` - URL: `https://nexhealth.info/payment_plans/{id}` - Auth: API key in header `Authorization` > 🚧 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`. ## Path parameters - `id` integer, required ## Query parameters - `include[]` string[] ## Headers - `Nex-Api-Version` string, required ## Response `200` Successful - APIV31EntitiesPaymentPlanDetailedResponse: API_V31_Entities_PaymentPlanDetailed_Response model - `code` boolean: Indicates the success or failure of the request - `description` string: Additional context on the request to help with debugging. - `error` string[]: Any errors that occur during the execution of the request. - `data` APIV31EntitiesPaymentPlanDetailed - `id` integer: Resource ID - `patient_id` integer: The ID of patient this plan is for - `guarantor_id` integer: The ID of the person paying for the plan - `first_payment_due_date` string, date: The date the first payment is due (this doesn’t include down payments) - `created_date` string, date: The date the payment plan was created - `active` boolean: Indicates whether the payment plan has been closed, cleared, or deleted from the system - `patient` APIV31EntitiesPatientBasic - `id` integer: User ID - `email` string: User email - `first_name` string: First name - `middle_name` string: Middle name - `last_name` string: Last name - `name` string: Full name - `created_at` string, date-time: User creation date in UTC - `updated_at` string, date-time: User last update date in UTC - `institution_id` integer: The institution this user belongs to - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it. - `foreign_id_type` string: Foreign ID type is a unique string identifier for the integrated system - `inactive` boolean: Is the user inactivated? - `home_phone_number` string: Home phone number - `work_phone_number` string: Work phone number - `work_phone_extension` string: Work phone extension - `cell_phone_number` string: Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number β€” which is how most systems report it back after a write β€” this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number. - `preferred_phone_number` string: The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only β€” write one of the typed phone number fields to change it. - `guarantor_id` integer: User ID of this patient's responsible party - `billing_type` string: Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type - `chart_id` string: User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users - `preferred_language` string: Patient's preferred language as an ISO 639-1 code, if specified in the integrated system - `provider_id` integer: User ID of this patient's primary provider - `gender` string: Gender from biographical data - `new_patient` boolean: Whether the patient is new - `non_patient` boolean: Whether this is a non-patient user record - `date_of_birth` string: Date of birth in YYYY-MM-DD format - `premedication` string: Premedication notes - `address` APIV2EntitiesPatientAddress - `line_1` string, nullable: Address line 1 - `line_2` string, nullable: Address line 2 - `postal_code` string, nullable: Zip code - `city` string, nullable: City - `region` string, nullable: State - `guarantor` APIV31EntitiesPatientBasic - `id` integer: User ID - `email` string: User email - `first_name` string: First name - `middle_name` string: Middle name - `last_name` string: Last name - `name` string: Full name - `created_at` string, date-time: User creation date in UTC - `updated_at` string, date-time: User last update date in UTC - `institution_id` integer: The institution this user belongs to - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it. - `foreign_id_type` string: Foreign ID type is a unique string identifier for the integrated system - `inactive` boolean: Is the user inactivated? - `home_phone_number` string: Home phone number - `work_phone_number` string: Work phone number - `work_phone_extension` string: Work phone extension - `cell_phone_number` string: Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number β€” which is how most systems report it back after a write β€” this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number. - `preferred_phone_number` string: The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only β€” write one of the typed phone number fields to change it. - `guarantor_id` integer: User ID of this patient's responsible party - `billing_type` string: Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type - `chart_id` string: User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users - `preferred_language` string: Patient's preferred language as an ISO 639-1 code, if specified in the integrated system - `provider_id` integer: User ID of this patient's primary provider - `gender` string: Gender from biographical data - `new_patient` boolean: Whether the patient is new - `non_patient` boolean: Whether this is a non-patient user record - `date_of_birth` string: Date of birth in YYYY-MM-DD format - `premedication` string: Premedication notes - `address` APIV2EntitiesPatientAddress - `line_1` string, nullable: Address line 1 - `line_2` string, nullable: Address line 2 - `postal_code` string, nullable: Zip code - `city` string, nullable: City - `region` string, nullable: State - `count` integer: Number of total objects, in case of collection. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `500`: Internal Server Error --- [API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)