Skip to main content
GET
List billing plans

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID.

room_id
string<uuid>[]

Alias combined with room_ids. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

room_ids
string<uuid>[]

Optional room UUID filters, combined with room_id. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

plan_status
string

Free-text plan status. Aggregate view defaults to active when omitted.

query
string

Row view only: search text.

has_alerts
boolean
default:false

Row view only: return only plans with alerts when true. Accepts true/1 and false/0, case-insensitive.

active_rooms_only
boolean
default:false

Row view only: restrict to active rooms. Accepts true/1 and false/0, case-insensitive.

sort_by
enum<string>

Aggregate view only. Sending sort_by without group_by returns 400.

Available options:
sum_monthly_invoice_asc,
sum_monthly_invoice_desc,
avg_monthly_invoice_asc,
avg_monthly_invoice_desc,
count_students_asc,
count_students_desc,
group_asc,
group_desc
group_by
enum<string>

Select an aggregate representation; metrics must also be supplied.

Available options:
school_id,
school_name,
room_id,
room_name
metrics
enum<string>[]

Metrics to calculate; required with group_by and invalid without it. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

Available options:
sum_monthly_invoice,
avg_monthly_invoice,
count_students
limit
integer
default:50

Aggregate result limit. Defaults to 50 and clamps values above 200 to 200. Zero and negative values use the default.

page
integer
default:1

One-based page number. Row view only.

Required range: x >= 1
per_page
integer
default:100

Items per page; values greater than 500 are clamped to 500. Row view only.

Required range: x >= 1

Response

Successful response.

Billing Plan.

id
string
required
student_id
string
required

Student id.

student_first_name
string | null
required
student_last_name
string | null
required
school_id
string
required

School id.

school_name
string
required
update_billing_plan_in_procare
string | null
required
billing_plan_audit
string | null
required
current_room_name
string | null
required
current_room_id
string | null
required
start_date
string | null
required
transition_date
string | null
required
withdrawal_date
string | null
required
template_timing
string
required
billing_plan_status
string | null
required
current_room_program
string | null
required
billing_plan
string | null
required
tuition_plan_program
string | null
required
transition_room_program
string | null
required
billing_cycle
string | null
required
invoiced_amount
number<double> | null
required
monthly_invoice_amount
number<double> | null
required
program_tuition_rate
number<double> | null
required
difference_monthly_invoice_amount
number<double> | null
required
payment_method_future
string | null
required
autopay
string | null
required
supply_fee_invoiced
number<double> | null
required
part_time
string
required
staff_child
string | null
required
siblings
string
required
family_id
string
required

Family id.

is_tuition_plan
boolean
required
color_hex
string
required
short_name
string
required
ems_student_status
string | null
required
processing_fee_calculated
number<double>
required
processing_plan_audit
string | null
required
field_labels
object | null
required
alerts
object[] | null
required