Skip to content

list_instalment_plan_templates

List instalment plan templates for a workspace. Optionally filter by product group ID or status. Use this to discover template IDs before calling assign_instalment_plan_templates or unassign_instalment_plan_templates.

Parameter Type Required Description
workspaceId string Yes The ID of the workspace to list instalment plan templates for
productGroupId string No Optional product group ID to filter templates assigned to a specific product group
status Status No Optional status filter (ACTIVE or EXPIRED). Defaults to all. - Status
academicYear AcademicYear No Optional academic year filter. Returns templates applicable to this academic year plus any year-agnostic templates (no academic year set). - AcademicYear
Value Description
ACTIVE Template is currently active and assignable
EXPIRED Template has expired and is no longer assignable
Value Description
YEAR_2025_2026 2025/26 academic year
YEAR_2026_2027 2026/27 academic year
YEAR_2027_2028 2027/28 academic year
YEAR_2028_2029 2028/29 academic year
YEAR_2029_2030 2029/30 academic year
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display