Skip to main content
GET
Get Public Payment Plan Summary

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

payment_plan_id
string
required

Response

Successful Response

Public-safe view of a plan for the patient self-serve recovery page (keyed by the plan id).

Intentionally minimal — exposes only what the page renders. amount_due is the FAILED installment's amount, or 0 when the plan is not delinquent (nothing to pay).

status
enum<string>
required
Available options:
ACTIVE,
DELINQUENT,
COMPLETED,
CANCELLED
amountDue
integer
required
frequency
enum<string>
required
Available options:
WEEKLY,
BIWEEKLY,
MONTHLY