Payment Plan

The Payment Plan feature allows a patient with a large outstanding balance to pay it off over time. Multiple payment plans can be created for the same patient. This feature allows the user to create and view payment plan details. Credit card payments can also be voided and non-credit card (cash/check) payments can be recorded in athenaNet. In addition, credit card payments not made via athenahealth's Credit Card Plus (CCP) can be recorded as having been made, however, we highly recommend using CCP (and /collectpayment). The Payment Reference allows the user to view the configured list of payment methods for the practice. For more information, please refer Payment Plans.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Create patient's payment plan
POST
/v1/{practiceid}/patients/{patientid}/collectpayment/paymentplan

Creates a payment plan for the patient. If payment is to be made via a credit card than provide the appropriate credit card fields.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Request Body

Expand all

Output Parameters

Expand all
epaymentid integer After a successful payment, this ID can be used to retrieve the receipt.
errortext string The error text returned by the credit card processor.
paymentplanid string The ID of the payment plan.
success string true for success. false for an error.
Example Code
View patient's payment-plan
GET
/v1/{practiceid}/patients/{patientid}/collectpayment/paymentplan

Retrieves payment plans for the patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
departmentid integer The department ID.
paymentplanids array One or more payment plan IDs.

Output Parameters

Expand all
amountdue integer Remaining amount due for the patient.
billingmethod string Billing method of the payment plan.
cycleamount integer The amount the patient is billed per cycle.
downpayment integer Down payment billed to the patient.
frequency string How often should the patient be billed (ONETIMEON - One-time charge, WEEKLY - Weekly, BIWEEKLY - Every two weeks, TWICEAMONTH - First and fifteenth of month, MONTHLY - Monthly, MONTHLYFIRSTBUSDAY - Monthly, first business day, MONTHLYLASTBUSDAY - Monthly, last business day).
name string Name of payment plan.
numfuturepayments integer Number of future payments the patient has to make.
outstanding integer Total outstanding amount.
paymentplanid integer Unique id of the payment plan.
paymentplantype string Type of payment plan.
plannotes string Comments for payment plan.
Example Code
Get list of non-credit-card payment methods
GET
/v1/{practiceid}/configuration/validnonccpcreditcardmethods

Retrieves a list of valid credit card methods for practices not using CCP for use with /patients/{patientid}/recordpayment

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
name string The name of this payment method (used in athenahealth's UI).
paymentmethod string The payment method identifier for use in /patients/{patientid}/recordpayment
Example Code