Manage Flex Plan

Configure the instalment schedule for a student identified by :jodo_student_id.

Endpoint

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

Request

curl -X POST 'https://[base_url]/api/v1/integrations/flex/students/:jodo_student_id/plans' \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "payment_schedule": [
      {
        "due_date": "2022-09-15",
        "details": [
          {
            "amount": 10500,
            "component_type": "TUITION_FEE"
          },
          {
            "amount": 500,
            "component_type": "TRANSPORT_FEE"
          }
        ]
      },
      {
        "due_date": "2022-11-15",
        "details": [
          {
            "amount": 20500,
            "component_type": "TUITION_FEE"
          }
        ]
      }
    ]
  }'

Request Body

Field	Type	Required	Description
payment_schedule	array	Yes	Instalments to configure for the student.
payment_schedule[].due_date	string	Yes	Instalment due date in YYYY-MM-DD format.
payment_schedule[].details	array	Yes	Fee component split for the instalment.
payment_schedule[].details[].component_type	string	Yes	Fee component code.
payment_schedule[].details[].amount	number	Yes	Amount for the fee component.
payment_schedule[].details[].is_downpayment	boolean	No	Set to true when the component is part of a downpayment instalment.

Response

{
  "status": "success"
}

Errors

• Fee component is not available.
• Student was not found.
• Subscription is already set up.

Notes

Call this API before the payer completes Flex setup. Once a subscription is set up, schedule changes should be handled through the supported update flow and webhook lifecycle.