flex.subscription.active

flex.subscription.active

Overview

The flex.subscription.active webhook event is triggered when a Jodo Flex subscription becomes active. The subscription is considered to be active when the bank confirms that the debits can happen even for E-sign based mandate setup. When Jodo receives confirmation from the bank, the flex.subscription.active webhook event is triggered.

Payload

Attribute	Type	Description
event_id	String	A unique identifier for the webhook event.
event	String	The event type; in this case, “flex.subscription.active”
timestamp	Integer	The Unix timestamp when the event was originated.
version	String	The version of the webhook payload format (here, “1.0”).
payload	Object	Detailed information about the event.
payload.jodo_student_id	String	The ID of the student in the JODO system.
payload.student	Object	Information about the student.
payload.student.identifier	String	The student’s identifier within your system (if applicable).
payload.student.custom_identifier	String	A custom identifier associated with the student.
payload.student.collector_code	String	Branch code (if applicable).
payload.student.grade	Object	Information about the student’s grade.
payload.student.grade.code	String	The code representing the grade (e.g., “M1BLUE”).
payload.student.grade.name	String	The name of the grade (e.g., “Montessori 1”).
payload.student.academic_year_start	Integer	The start year of the student’s academic year.
payload.student.academic_year_end	Integer	The end year of the student’s academic year.
payload.student.primary_contact_number	String	The primary contact number of the student’s parent or guardian.
payload.student.primary_contact_email	String	The primary contact email address of the student’s parent or guardian.
payload.subscription	Object	Information about the flex subscription.
payload.subscription.id	String	The unique identifier of the flex subscription.
payload.subscription.status	String	The current status of the flex subscription.
payload.payment_schedule	Array	Instalment details.
payload.payment_schedule[].amount	Integer	Instalment amount.
payload.payment_schedule[].due_date	String	The due date of an installment in the payment schedule of the student.
payload.payment_schedule[].details	Array	An array containing the breakdown of the payment details.
payload.payment_schedule[].details[].fee_component	String	The type of fee component (e.g., TUITION_FEE, TRANSPORT_FEE).
payload.payment_schedule[].details[].amount	Integer	The amount to be paid for the corresponding fee component.

Example

{
  "event_id": "37a87051-4b9f-4540-a155-2e8f2dd8354f",
  "event": "flex.subscription.active",
  "timestamp": 1655448963,
  "version": "1.0",
  "payload": {
    "jodo_student_id": "student_1234",
    "student": {
      "identifier": "STUDENT_IDENTIFIER",
      "custom_identifier": "CUSTOM_IDENTIFIER",
      "collector_code": "81c6b473c138",
      "fullname": "Ron Rivest",
      "academic_year_start": 2022,
      "academic_year_end": 2023,
      "primary_contact_number": "9876543210",
      "primary_contact_email": "customer@example.com",
      "grade": { "name": "Class I", "code": "fdb97be4" }
    },
    "subscription": { "id": "subs_88001", "status": "active" },
    "payment_schedule": [
      {
        "amount": 5000,
        "due_date": "2022-03-01",
        "details": [
          { "fee_component": "TUITION_FEE", "amount": 2500 },
          { "fee_component": "TRANSPORT_FEE", "amount": 2500 }
        ]
      },
      {
        "amount": 5000,
        "due_date": "2022-04-01",
        "details": [
          { "fee_component": "TUITION_FEE", "amount": 2500 },
          { "fee_component": "TRANSPORT_FEE", "amount": 2500 }
        ]
      }
    ]
  }
}

Handling the Event

Upon receiving the flex.subscription.active event, you can update your systems to reflect that the mandate is ready for auto-debit. This is useful for ensuring that users can only access services when future installment debits are confirmed.