Subplan rates

General commission rates for each producer role in BillingCenter are defined when you first create a subplan. These rates are required to create the subplan, so they must be included in the initial POST request. However, to view or update the rates after the subplan is created, you must use the endpoints described in this topic.

Query for subplan rates

Query for subplan rates with the following endpoints:

  • GET /commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commission-sub-plan-rates
  • GET /commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commission-sub-plan-rates/{commissionSubPlanRateId}

The following call retrieves all the subplan rates on a subplan:

Command

GET /admin/v1/commission-plans/bc:134/commission-sub-plans/bc:199/commission-sub-plan-rates

Response

{
    "count": 3,
    "data": [
        {
            "attributes": {
                "id": "bc:SPTtB8qdjkmQmCxDy9_hJ",
                "rate": "15.00",
                "role": {
                    "code": "primary",
                    "name": "Primary"
                }
            },
	     ...
        },
        {
            "attributes": {
                "id": "bc:SIvKgiRyl97fWbTgU_12e",
                "rate": "5.00",
                "role": {
                    "code": "secondary",
                    "name": "Secondary"
                }
            },
            ...
        },
        ...
    }
}

Modify subplan rates

Modify subplan rates with the following endpoint:

  • PATCH /commission-plans/{commissionPlanId}/commission-sub-plans/{commissionSubPlanId}/commission-sub-plan-rates/{commissionSubPlanRateId}

If the subplan is not in use, the subplan rate can be PATCHed. The rate field is the only field that can be updated. For example, the following request changes a subplan rate to be 10.5%.

Command

PATCH /commission-plans/bc:134/commission-sub-plans/bc:199/commission-sub-plan-rates/bc:204

Request body

{
    "data": {
        "attributes": {
            "rate": "10.5"
        }
    }
}

You cannot delete subplan rates.