Commission plan management

Your billing plugin must be able to retrieve all the commission plans from your billing system. Implement the plugin method retrieveAllCommissionPlans, which takes no arguments. It returns an array of CommissionPlanSummary objects. The fully qualified class name is gw.api.billing.CommissionPlanSummary.

This method is notably different from most other methods because PolicyCenter always calls this method synchronously with respect to the user interface. PolicyCenter uses this method to populate a drop down list for commission plans if using agency bill.

PolicyCenter allows the user to set this commission plan information initially only. For any later changes, you must directly change the information in the billing system.

Set the following properties on each CommissionPlanSummary object

  • Name – The name of the plan
  • Id – The ID for the plan
  • AllowedTiers – An array of Tier typecodes that this commission plan supports