PaymentPlan

The PaymentPlan object

The PaymentPlan object looks like this in JSON:

{
    "object": "payment_plan",
    "id": 1,
    "name": "Calendar Plan",
    "status": "active",
    "amount": 55,
    "amount_type": "flat",
    "late_fee": 0,
    "late_fee_type": "percent",
    "grace_period_days": null,
    "max_late_fee": 0,
    "schedule_type": "date",
    "charge_types_broken_out": false,
    "prefer_whole_dollar_amounts": false,
    "recurring_money_transfer_linkable_student_level": false,
    "recurring_money_transfer_linkable_term_level": false,
    "recurring_money_transfer_linkable_existing": false,
    "recurring_first_payment": "day_of_month",
    "recurring_day_of_month": 1,
    "recurring_days_after_start": 30,
    "recurring_period_months": 1,
    "recurring_amount": 0,
    "balance_year": null,
    "balance_month": 3,
    "balance_day": 3,
    "balance_num_days": null,
    "fee_id": 2,
    "late_fee_id": null,
    "min_invoice_amount": 0,
    "exclude_aid": false,
    "scheduled_aid_handling": "consider_allocation_time",
    "tuition_eligible": "all",
    "fees_eligible": "selected",
    "room_plans_eligible": "none",
    "meal_plans_eligible": "all",
    "bookstore_eligible": "all",
    "auto_remove_on_payoff": false,
    "auto_remove_date": null,
    "added_at": "2022-07-13T20:47:23+00:00",
    "added_by_id": 10,
    "updated_at": "2022-07-13T20:54:57+00:00",
    "updated_by_id": 10,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
name	Yes	text (200)
status	Yes	enum (active, deleted)
amount	Yes	decimal
amount_type	Yes	enum (flat, percent)
late_fee	Yes	decimal
late_fee_type	Yes	enum (flat, percent)
grace_period_days	Yes	int
max_late_fee	Yes	decimal
schedule_type	Yes	enum (date, days_into_term, days_from_applied, recurring)
charge_types_broken_out	Yes	bool
prefer_whole_dollar_amounts	Yes	bool
recurring_money_transfer_linkable_student_level	Yes	bool
recurring_money_transfer_linkable_term_level	Yes	bool
recurring_money_transfer_linkable_existing	Yes	bool
recurring_first_payment	No	enum (day_of_month, days_after_start)
recurring_day_of_month	No	int
recurring_days_after_start	No	int
recurring_period_months	No	int
recurring_amount	Yes	decimal
balance_year	Yes	int
balance_month	Yes	int
balance_day	Yes	int
balance_num_days	Yes	int
fee_id	Yes	int
late_fee_id	Yes	int
min_invoice_amount	Yes	decimal
exclude_aid	Yes	bool
scheduled_aid_handling	Yes	enum (ignore, consider_allocation_time, always_exclude)
tuition_eligible	Yes	enum (all, none, selected, excluded)
fees_eligible	Yes	enum (all, none, selected, excluded)
room_plans_eligible	Yes	enum (all, none, selected, excluded)
meal_plans_eligible	Yes	enum (all, none, selected, excluded)
bookstore_eligible	Yes	enum (all, none, selected, excluded)
auto_remove_on_payoff	Yes	bool
auto_remove_date	No	date
added_at	No	datetime
added_by_id	No	int
updated_at	No	datetime
updated_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/paymentplans" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/paymentplans',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/paymentplans',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/paymentplans"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/paymentplans');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "payment_plan",
            "id": 1,
            "name": "Calendar Plan",
            "status": "active",
            "amount": 55,
            "amount_type": "flat",
            "late_fee": 0,
            "late_fee_type": "percent",
            "grace_period_days": null,
            "max_late_fee": 0,
            "schedule_type": "date",
            "charge_types_broken_out": false,
            "prefer_whole_dollar_amounts": false,
            "recurring_money_transfer_linkable_student_level": false,
            "recurring_money_transfer_linkable_term_level": false,
            "recurring_money_transfer_linkable_existing": false,
            "recurring_first_payment": "day_of_month",
            "recurring_day_of_month": 1,
            "recurring_days_after_start": 30,
            "recurring_period_months": 1,
            "recurring_amount": 0,
            "balance_year": null,
            "balance_month": 3,
            "balance_day": 3,
            "balance_num_days": null,
            "fee_id": 2,
            "late_fee_id": null,
            "min_invoice_amount": 0,
            "exclude_aid": false,
            "scheduled_aid_handling": "consider_allocation_time",
            "tuition_eligible": "all",
            "fees_eligible": "selected",
            "room_plans_eligible": "none",
            "meal_plans_eligible": "all",
            "bookstore_eligible": "all",
            "auto_remove_on_payoff": false,
            "auto_remove_date": null,
            "added_at": "2022-07-13T20:47:23+00:00",
            "added_by_id": 10,
            "updated_at": "2022-07-13T20:54:57+00:00",
            "updated_by_id": 10
        }
    ],
    "sandbox": true
}

Retrieves all PaymentPlan objects.

HTTP Request

GET /paymentplans

Parameters

None

Permissions

One of the following roles is required to call this method:

Financial Admin
Financial Auditor
Student Billing
Financial Aid
Financial Admin

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/paymentplans/(paymentplan)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/paymentplans/(paymentplan)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/paymentplans/(paymentplan)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/paymentplans/(paymentplan)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/paymentplans/(paymentplan)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "payment_plan",
    "id": 1,
    "name": "Calendar Plan",
    "status": "active",
    "amount": 55,
    "amount_type": "flat",
    "late_fee": 0,
    "late_fee_type": "percent",
    "grace_period_days": null,
    "max_late_fee": 0,
    "schedule_type": "date",
    "charge_types_broken_out": false,
    "prefer_whole_dollar_amounts": false,
    "recurring_money_transfer_linkable_student_level": false,
    "recurring_money_transfer_linkable_term_level": false,
    "recurring_money_transfer_linkable_existing": false,
    "recurring_first_payment": "day_of_month",
    "recurring_day_of_month": 1,
    "recurring_days_after_start": 30,
    "recurring_period_months": 1,
    "recurring_amount": 0,
    "balance_year": null,
    "balance_month": 3,
    "balance_day": 3,
    "balance_num_days": null,
    "fee_id": 2,
    "late_fee_id": null,
    "min_invoice_amount": 0,
    "exclude_aid": false,
    "scheduled_aid_handling": "consider_allocation_time",
    "tuition_eligible": "all",
    "fees_eligible": "selected",
    "room_plans_eligible": "none",
    "meal_plans_eligible": "all",
    "bookstore_eligible": "all",
    "auto_remove_on_payoff": false,
    "auto_remove_date": null,
    "added_at": "2022-07-13T20:47:23+00:00",
    "added_by_id": 10,
    "updated_at": "2022-07-13T20:54:57+00:00",
    "updated_by_id": 10,
    "sandbox": true
}

Retrieves a specific PaymentPlan object.

HTTP Request

GET /paymentplans/(paymentplan)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

schedules
eligible_charges
fee
late_fee

Permissions

One of the following roles is required to call this method:

Financial Admin
Financial Auditor
Student Billing
Financial Aid
Financial Admin