Flex
Flex lets students and parents pay structured fees in instalments through an auto-debit mandate.
Use Flex when the institute already has a student, fee structure, and academic-year context, and the payment needs to be broken into a managed schedule with debits, settlements, bounces, and lifecycle updates.
How it Works
Section titled “How it Works”- Create or update the student record in Jodo.
- Sync the student’s fee structure and any existing payments.
- Configure the Flex plan or make Flex products available for the student.
- The parent or student completes Flex setup and authorises the mandate.
- Jodo manages scheduled instalment debits.
- Your ERP receives webhook events for setup, activation, updates, debits, settlements, bounces, cancellation, and closure.
Key Concepts
Section titled “Key Concepts”- Student: The Jodo student record that owns the fee structure and Flex plan.
- Fee structure: The fee components and payable amounts that can be converted into an instalment schedule.
- Subscription: The Flex plan created after the payer completes setup and authorises debits.
- Instalment: A scheduled debit within the subscription.
- Downpayment: An upfront payment collected during Flex setup, if applicable.
- Mandate: The bank authorisation that allows scheduled auto-debits.
Shared Student APIs
Section titled “Shared Student APIs”These APIs maintain the student and fee context used by Flex, Pay, and Cred.
Register Student
Create a student record with profile, fee, and optional existing payment details.
Open reference → Student APIGet Student
Retrieve student profile, identifiers, and related details.
Open reference → Student APIUpdate Student
Update student profile and guardian contact details.
Open reference → Student APIUpdate Fee
Update the fee components that define the payable amount.
Open reference → Student APIList Products
Retrieve products available for a student, including Flex products.
Open reference → Student APIList Payments
Retrieve payment history for the student.
Open reference → Student APIAdd Payment
Record an institute-collected payment against the student.
Open reference → Student APICancel Payment
Cancel a previously recorded student payment.
Open reference →Flex APIs
Section titled “Flex APIs”These APIs are specific to Flex products and instalment schedule setup.
Manage Flex Plan
Configure or update a student-specific Flex instalment schedule.
Open reference → Flex APIGet Flex Schedule
Fetch the configured Flex instalment schedule for a student.
Open reference →Webhooks
Section titled “Webhooks”Subscribe to Flex webhook events to keep the ERP in sync with the full subscription lifecycle.
subscription.setup
Customer has completed Flex setup.
Webhooksubscription.active
Bank has confirmed the mandate is active.
Webhooksubscription.updated
Flex subscription schedule has been updated.
Webhooksubscription.cancelled
Flex subscription has been cancelled.
Webhooksubscription.closed
Flex subscription has been closed.
Webhookinstalment.debited
An instalment has been successfully debited.
Webhookinstalment.settled
An instalment has been settled to the institute.
Webhookinstalment.bounced
An instalment debit has bounced.
Webhookdownpayment.debited
A downpayment has been successfully debited.
Webhookdownpayment.settled
A downpayment has been settled to the institute.
Implementation Notes
Section titled “Implementation Notes”- Keep student identifiers stable between your ERP and Jodo.
- Sync fee components before Flex setup so the instalment schedule is based on the latest payable amount.
- Process webhook events idempotently. Instalment and subscription events can be retried.
- Treat
subscription.activeas the signal that the mandate is ready for scheduled debits. - Use debited and settled events separately: debit confirms customer payment, settlement confirms transfer to the institute.