Price Comparison Response

Output representation of the price impact that's calculated for a group census. The response includes the available product categories, the event summary, the rating periods, the currency, and a flat list of comparison items that carry the previous and current amounts for each plan, group class, member, and coverage.

JSON example

1{
2  "categories": {
3    "dental": "Dental",
4    "vision": "Vision"
5  },
6  "comparisons": [
7    {
8      "category": null,
9      "current": {
10        "attributes": [],
11        "fee": 400.00,
12        "id": "0rHxx000000001aEAA",
13        "premium": 2000.00,
14        "tax": 180.00,
15        "total": 2580.00
16      },
17      "durationKey": "dur1",
18      "id": "identifier1",
19      "name": null,
20      "node": "summary",
21      "parent": null,
22      "previous": {
23        "attributes": [],
24        "fee": 200.00,
25        "id": "0rHxx000000002bEAA",
26        "premium": 1800.00,
27        "tax": 180.00,
28        "total": 2180.00
29      }
30    },
31    {
32      "category": "vision",
33      "current": {
34        "attributes": [],
35        "fee": 40.00,
36        "id": "0rHxx000000003cEAA",
37        "premium": 2000.00,
38        "tax": 180.00,
39        "total": 2220.00
40      },
41      "durationKey": "dur1",
42      "id": "identifier2",
43      "name": "Vision Gold",
44      "node": "plan",
45      "parent": null,
46      "previous": {
47        "attributes": [],
48        "fee": 20.00,
49        "id": "0rHxx000000004dEAA",
50        "premium": 1800.00,
51        "tax": 180.00,
52        "total": 2000.00
53      }
54    }
55  ],
56  "currencyInfo": {
57    "locale": "en_US",
58    "name": "USD",
59    "symbol": "$"
60  },
61  "durations": [
62    {
63      "effectiveFrom": "2026-01-01",
64      "effectiveTo": "2026-12-31",
65      "key": "dur1"
66    }
67  ],
68  "errors": [],
69  "isSuccess": true,
70  "summary": {
71    "endorse": 10,
72    "enrollment": 0,
73    "hire": 20,
74    "terminate": 10
75  }
76}

Property Name	Type	Description	Filter Group and Version	Available Version
`categories`	Map<String, String>	Map of the product categories that are available for the group census, where the key is the category ID and the value is the category label. Pass a key from this map as the `category` property of a later request to filter the comparison.	Small, 68.0	68.0
`comparisons`	Price Comparison Item Details[]	Flat list of the comparison items for the group census. Each item carries the previous and current amounts for a node in the hierarchy, such as the overall summary, a plan, a group class, a member, or a coverage.	Small, 68.0	68.0
`currencyInfo`	Price Comparison Currency Details	Currency in which all the amounts in the response are expressed. All the amounts use the org currency.	Small, 68.0	68.0
`durations`	Price Comparison Duration Details[]	List of the rating periods that the comparison covers. Comparison items refer to these periods through their `durationKey` property.	Small, 68.0	68.0
`errors`	Error Details[]	List of the errors that occurred while the price comparison was calculated. The list is empty when `isSuccess` is `true`.	Small, 68.0	68.0
`isSuccess`	Boolean	Indicates whether the price comparison is calculated successfully (`true`) or not (`false`).	Small, 68.0	68.0
`summary`	Price Comparison Summary Details	Counts of the membership events in the group census, such as hires, endorsements, and terminations, that contribute to the price change.	Small, 68.0	68.0

Insurance Developer Guide

Price Comparison Response