Get Calculate Fees Template for Course
Calculates the instalments a learner would pay for a course under a fee template: amounts, due dates, discount from a promo code and GST. Use it on a checkout page before enrollment.
GET
/calculatesplitGet Calculate Fees Template for Course
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/calculatesplit?institution_bundle_id=<institutionBundleId>&template_id=<templateId>'{
"code": 200,
"message": "Success",
"payment_split": {
"institution_bundle_id": "503",
"template_id": "302",
"package_due_date": "19/05/2022",
"expiration_after": 0,
"currency_original_cost": 10,
"original_cost": 10,
"currency_symbol": "₹",
"organization_base_currency": 49,
"currency_id": 49,
"rate": "1.00000",
"num_of_decimals": 2,
"position": 1,
"adjustment_rate": "0.00000",
"package_cost_set": 1,
"promocode_discount": 0,
"organization_id": 417,
"payment_splits": [
{
"instalment_name": "Full Payment",
"currency_symbol": "₹",
"position": 1,
"part_amount": 10,
"part_date": 1652918400,
"part_formatted_date": "19/05/2022",
"discount": 0,
"final_amount": 10
}
]
}
}Access: Public, no API key.
Query parameters
Course listing ID.
Fee template (from "Get Fees Template by Organization ID"). Must be offered for this course.
promo_code_textstring
Promo code to apply. Letters and digits only.
master_batch_idinteger
Batch, when the template is set per batch. Default
0.currency_idinteger
Currency to price in. Defaults to the organization's display currency.
date_of_admissionUnix timestamp
Enrollment date that due dates count from. Default today.
Response
codeinteger
Example:
200messagestring
Example:
Successpayment_splitobject
Show child attributesHide child attributes
Example:
503Example:
302Example:
0payment_split.original_costinteger
Example:
10Example:
₹Example:
49payment_split.currency_idinteger
Example:
49payment_split.ratestring
Example:
1.00000Example:
2payment_split.positioninteger
Example:
1Example:
0.00000Example:
1Example:
0Example:
417payment_split.payment_splitsobject[]
Show child attributesHide child attributes
Example:
Full PaymentExample:
₹Example:
1Example:
10Example:
0Example:
10Notes: GST applies only to INR prices when the institute has GST on; IGST or CGST+SGST is chosen from the caller's location. Errors: "Package cost is not set in branch's base currency." and "Something went wrong." (template not offered for this course). Rate limit: 30 requests per minute; going over locks you out for 30 minutes.