Newer Version Available

This content describes an older version of this product. View Latest

Rate Plan

Output representation of the details of the rate plans associated directly with the policy or through coverages.
JSON example
This example shows a sample success response.
1"ratePlans": [
2          {
3            "id": "rp11",
4            "totalPremiumAmount": 350,
5            "totalFeeAmount": 200,
6            "totalPremiumEqvAmount": 100,
7            "expectedRevenueAmount": 45,
8            "ratePlanCommissions": [
9              {
10                "id": "rpc111",
11                "premiumPercent": 100,
12                "type": "FlatPercentOfPremium"
13              }
14            ]
15          },
16          {
17            "id": "rp12",
18            "totalPremiumAmount": 350,
19            "totalFeeAmount": 200,
20            "totalPremiumEqvAmount": 100,
21            "expectedRevenueAmount": 45,
22            "ratePlanCommissions": [
23              {
24                "id": "rpc111",
25                "premiumPercent": null,
26                "type": "GradedPercent",
27                "amountStartRange": 0,
28                "amountEndRange": 1000
29              },
30              {
31                "id": "rpc112",
32                "premiumPercent": null,
33                "type": "GradedPercent",
34                "amountStartRange": 1001,
35                "amountEndRange": 10000
36              },
37            ]
38          }
39        ]
Property Name Type Description Filter Group and Version Available Version
expectedRevenue​Amount Double Expected revenue amount for the specified policy. Small, 63.0 63.0
id String ID of the rate plan. Small, 63.0 63.0
ratePlan​Commissions Rate Plan Commission[] Details of the rate plan commissions. Small, 63.0 63.0
totalFee​Amount Double Total fee amount that's calculated for rate plan and then rolled up to policy. Small, 63.0 63.0
totalPremium​Amount Double Total premium amount that's calculated for rate plan and then rolled up to policy. Small, 63.0 63.0
totalPremium​EqvAmount Double Total premium equivalent amount that's calculated for rate plan and then rolled up to policy. Small, 63.0 63.0