curl --request GET \
--url https://{host}/primula/api/v3/billing_plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/billing_plans"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/billing_plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/billing_plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/billing_plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/billing_plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/billing_plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"student_id": "<string>",
"student_first_name": "<string>",
"student_last_name": "<string>",
"school_id": "<string>",
"school_name": "<string>",
"update_billing_plan_in_procare": "<string>",
"billing_plan_audit": "<string>",
"current_room_name": "<string>",
"current_room_id": "<string>",
"start_date": "<string>",
"transition_date": "<string>",
"withdrawal_date": "<string>",
"template_timing": "<string>",
"billing_plan_status": "<string>",
"current_room_program": "<string>",
"billing_plan": "<string>",
"tuition_plan_program": "<string>",
"transition_room_program": "<string>",
"billing_cycle": "<string>",
"invoiced_amount": 123,
"monthly_invoice_amount": 123,
"program_tuition_rate": 123,
"difference_monthly_invoice_amount": 123,
"payment_method_future": "<string>",
"autopay": "<string>",
"supply_fee_invoiced": 123,
"part_time": "<string>",
"staff_child": "<string>",
"siblings": "<string>",
"family_id": "<string>",
"is_tuition_plan": true,
"color_hex": "<string>",
"short_name": "<string>",
"ems_student_status": "<string>",
"processing_fee_calculated": 123,
"processing_plan_audit": "<string>",
"field_labels": {},
"alerts": [
{
"id": "<string>",
"level": 123,
"description": "<string>"
}
]
}
]List billing plans
Scoped to company_id; the handler does not restrict this read to the session school assignments. Returns consolidated billing-plan rows, or nested BillingPlanAggregate rows when group_by and metrics are supplied. school_id is always required. A consolidated row keeps the ID of the first plan in its group.
Rows support plan_status, room filters, query, has_alerts, active_rooms_only and pagination; sorting rows returns 400. Aggregates use school, room filters, plan_status (default active), group_by, metrics, sort_by and limit. query, has_alerts and active_rooms_only do not affect aggregate results, although boolean values are parsed and validated. X-Has-Alerts applies only to row responses; X-Room-Filter-Count and X-Truncated apply only to aggregates.
curl --request GET \
--url https://{host}/primula/api/v3/billing_plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/billing_plans"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/billing_plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/billing_plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/billing_plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/billing_plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/billing_plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"student_id": "<string>",
"student_first_name": "<string>",
"student_last_name": "<string>",
"school_id": "<string>",
"school_name": "<string>",
"update_billing_plan_in_procare": "<string>",
"billing_plan_audit": "<string>",
"current_room_name": "<string>",
"current_room_id": "<string>",
"start_date": "<string>",
"transition_date": "<string>",
"withdrawal_date": "<string>",
"template_timing": "<string>",
"billing_plan_status": "<string>",
"current_room_program": "<string>",
"billing_plan": "<string>",
"tuition_plan_program": "<string>",
"transition_room_program": "<string>",
"billing_cycle": "<string>",
"invoiced_amount": 123,
"monthly_invoice_amount": 123,
"program_tuition_rate": 123,
"difference_monthly_invoice_amount": 123,
"payment_method_future": "<string>",
"autopay": "<string>",
"supply_fee_invoiced": 123,
"part_time": "<string>",
"staff_child": "<string>",
"siblings": "<string>",
"family_id": "<string>",
"is_tuition_plan": true,
"color_hex": "<string>",
"short_name": "<string>",
"ems_student_status": "<string>",
"processing_fee_calculated": 123,
"processing_plan_audit": "<string>",
"field_labels": {},
"alerts": [
{
"id": "<string>",
"level": 123,
"description": "<string>"
}
]
}
]Authorizations
Access token issued by POST /sessions and associated with a valid server-side session.
Query Parameters
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 UUID.
Alias combined with room_ids. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.
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.
Free-text plan status. Aggregate view defaults to active when omitted.
Row view only: search text.
Row view only: return only plans with alerts when true. Accepts true/1 and false/0, case-insensitive.
Row view only: restrict to active rooms. Accepts true/1 and false/0, case-insensitive.
Aggregate view only. Sending sort_by without group_by returns 400.
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 Select an aggregate representation; metrics must also be supplied.
school_id, school_name, room_id, room_name 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.
sum_monthly_invoice, avg_monthly_invoice, count_students Aggregate result limit. Defaults to 50 and clamps values above 200 to 200. Zero and negative values use the default.
One-based page number. Row view only.
x >= 1Items per page; values greater than 500 are clamped to 500. Row view only.
x >= 1Response
Successful response.
- Option 1 · object[]
- Option 2 · object[]
Billing Plan.
Student id.
School id.
Family id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes