Get Flex Schedule

Use this API to fetch the Flex payment schedule configured for a student.

Endpoint

GET /api/v1/integrations/flex/students/:jodo_student_id/plans

Request

curl -X GET 'https://[base_url]/api/v1/integrations/flex/students/:jodo_student_id/plans' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic <token>'

Path Parameters

Parameter	Type	Required	Description
jodo_student_id	string	Yes	Jodo student ID for which the Flex schedule should be fetched.

Response

HTTP 200

{
  "status": "success",
  "data": {
    "payment_schedule": [
      {
        "due_date": "2022-12-11",
        "amount": 20000.0,
        "details": [
          {
            "component_type": "ADMISSION_FEE",
            "amount": 0.0
          },
          {
            "component_type": "COURSE_FEE",
            "amount": 20000.0
          }
        ]
      },
      {
        "due_date": "2022-12-12",
        "amount": 30000.0,
        "details": [
          {
            "component_type": "ADMISSION_FEE",
            "amount": 0.0
          },
          {
            "component_type": "COURSE_FEE",
            "amount": 30000.0
          }
        ]
      }
    ]
  }
}

Response Data

Attribute	Type	Description
data.payment_schedule	array	List of Flex instalments for the student.
data.payment_schedule[].due_date	string	Instalment due date.
data.payment_schedule[].amount	number	Instalment amount.
data.payment_schedule[].details	array	Fee component split for the instalment.
data.payment_schedule[].details[].component_type	string	Fee component code.
data.payment_schedule[].details[].amount	number	Fee component amount.

Implementation Notes

• Use this API after configuring a Flex plan to verify the schedule stored in Jodo.
• Use webhook events to track lifecycle changes after the payer completes setup.