Commissionable items

Every commission subplan must identify a list of commissionable items. A commissionable item is a charge on a policy for which the producer earns commission. Commissionable items are specified by charge pattern category. For example, in the base configuration, you can specify Premium as a commissionable item. This means that producers would earn commission on any charge with a charge pattern whose type is Premium.

When creating a commission plan, if there are no commissionable items defined, then no commission will be earned on that subplan.

Commissionable items can be added, modified, and deleted through Cloud API.

Query for commissionable items

Query for commissionable items using the following endpoints:
  • GET /admin/v1/commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commissionable-charge-items
  • GET /admin/v1/commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commissionable-charge-items/{commissionableChargeItemId}

For example, the following call retrieves a commissionable item on a commission subplan:

Command
GET /admin/v1/commission-plans/bc:134/commission-sub-plans/bc:199/commissionable-charge-items/bc:232
Response
{
    "data": {
        "attributes": {
            "chargePattern": {
                "displayName": "Premium Including Taxes",
                "id": "default_data:16",
                "type": "ChargePattern",
                "uri": "/admin/v1/charge-patterns/default_data:16"
            },
            "id": "bc:232"
        },
        ...
    }
}

Adding commissionable items to a subplan

Add a commissionable item to a subplan using the following endpoint:
  • POST /admin/v1/commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commissionable-charge-items

The only required field is chargePattern, which is a reference to the ChargePattern typelist.

Here is an example post:

Command
POST /admin/v1/commission-plans/bc:134/commission-sub-plans/bc:199/commissionable-charge-items
Request body
{
    "data": {
        "attributes": {
            "chargePattern": {
                "id": "default_data:10"
            }
        }
    }
}

Update a commissionable item

You can update a commissionable item on a subplan using the following endpoint:
  • PATCH /admin/v1/commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commissionable-charge-items

When you PATCH a commissionable item, the only field you can patch is chargePattern. If you PATCH this field to be a different charge pattern from the original, it is effectively the same as DELETEing the original charge pattern and POSTing a new one, though the id of the commissionable item remains the same.

Here’s an example PATCH request:

Command
PATCH /admin/v1/commission-plans/bc:134/commission-sub-plans/bc:199/commissionable-charge-items/bc:232
Request body
{
    "data": {
        "attributes": {
            "chargePattern": {
                "id": "default_data:11"
            }
        }
    }
}

Delete a commissionable item

You can delete a commissionable item using the following endpoint:
  • DELETE /admin/v1/commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commissionable-charge-items

DELETEing a commissionable item returns a successful response.