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

This JSON sample shows a response with price comparison details when fetchAttributes is set to false by default.

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}

This JSON sample shows a response with attribute comparison details when fetchAttributes is set to true.

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

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