--- schema_version: "1" id: 7388c2a29a873a5dcc4b23dfd59f329c3585bafbb1a48fa580097d589e0b1cdd title: Price Comparison Response collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/connect_responses_price_comparison_output.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_output.htm source_site: developer.salesforce.com content_type: documentation content_hash: 63929a21cef5e2355afdad74e5ea5d8cbe52a3a264f573ff9dc94c9b2b5116bc description: 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. --- # 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. { "categories": { "dental": "Dental", "vision": "Vision" }, "comparisons": \[ { "category": null, "current": { "attributes": \[\], "fee": 400.00, "id": "0rHxx000000001aEAA", "premium": 2000.00, "tax": 180.00, "total": 2580.00 }, "durationKey": "dur1", "id": "identifier1", "name": null, "node": "summary", "parent": null, "previous": { "attributes": \[\], "fee": 200.00, "id": "0rHxx000000002bEAA", "premium": 1800.00, "tax": 180.00, "total": 2180.00 } }, { "category": "vision", "current": { "attributes": \[\], "fee": 40.00, "id": "0rHxx000000003cEAA", "premium": 2000.00, "tax": 180.00, "total": 2220.00 }, "durationKey": "dur1", "id": "identifier2", "name": "Vision Gold", "node": "plan", "parent": null, "previous": { "attributes": \[\], "fee": 20.00, "id": "0rHxx000000004dEAA", "premium": 1800.00, "tax": 180.00, "total": 2000.00 } } \], "currencyInfo": { "locale": "en\_US", "name": "USD", "symbol": "$" }, "durations": \[ { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } \], "errors": \[\], "isSuccess": true, "summary": { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } } This JSON sample shows a response with attribute comparison details when fetchAttributes is set to true. { "categories": { "dental": "Dental", "vision": "Vision" }, "comparisons": \[ { "current": { "attributes": \[\], "id": "0rHxx000000001aEAA" }, "durationKey": "dur1", "id": "identifier1", "node": "summary", "previous": { "id": "0rIxx000000001bEAA", "attributes": \[ { "name": "copay", "value": "100", "type": "Currency" }, { "name": "coinsurance", "value": "10", "type": "Percent" } \] } }, { "category": "vision", "current": { "attributes": \[\], "id": "0rHxx000000003cEAA" }, "durationKey": "dur1", "id": "identifier2", "name": "Vision Gold", "node": "plan", "previous": { "id": "0rIxx000000003dEAA", "attributes": \[ { "name": "copay", "value": "100", "type": "Currency" }, { "name": "coinsurance", "value": "10", "type": "Percent" } \] } } \], "currencyInfo": { "locale": "en\_US", "name": "USD", "symbol": "$" }, "durations": \[ { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } \], "errors": \[\], "isSuccess": true, "summary": { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | categories | Map | 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item.htm "Output representation of the details of a single node in the price comparison, such as the overall summary, a plan, a group class, a member, or a coverage. The comparison is returned as a flat list of items. Build the hierarchy by matching the parent value of an item with the id value of another item.")\[\] | 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_currency.htm "Output representation of the details of the currency that all amounts in a price comparison are expressed in. Use these details to format the previous and current amounts for display.") | 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item_duration.htm "Output representation of the details of a rating period that the comparison amounts apply to. Match the key value with the durationKey value of a comparison item to find the period that the item's amounts cover.")\[\] | 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_summary.htm "Output representation of the counts of the membership events in the group census that contribute to the price change, such as hires, endorsements, and terminations. Use these counts to explain why the price moved between the previous and the current amounts.") | 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 |