curl --request GET \
--url https://{host}/primula/api/v3/billing_plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/billing_plans/{id}"
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/{id}', 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/{id}",
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/{id}"
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/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/billing_plans/{id}")
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>"
}
]
}Get a consolidated billing plan
Scoped to company_id; the handler does not restrict this read to the session school assignments. Requires school_id. The ID is the consolidated row ID returned by the collection (the first plan ID in a group). Collection filters do not affect the lookup, though the shared parser still validates any supplied room IDs and boolean filters. Returns 404 when the school has no matching consolidated plan.
curl --request GET \
--url https://{host}/primula/api/v3/billing_plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/billing_plans/{id}"
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/{id}', 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/{id}",
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/{id}"
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/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/billing_plans/{id}")
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.
Path Parameters
UUID identifying this resource.
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.
Response
Successful response.
Billing Plan.
Student id.
School id.
Family id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes