Plan Benefits Product Model Details

Output representation of the product model details and associated product components.

JSON Example

This example shows a sample success response.

1{
2    "isSuccess":true,
3    "errors":[],
4    "productId": "01tSG0000013itZYAQ",
5    "benefits": [
6        {
7            "id": "01tSG0000011y9dYAA",
8            "name": "Annual deductible/Individual",
9            "componentGroupId": "0y7SG0000000Q8zYAE",
10            "componentGroupName": "General plan information",
11            "componentGroupSequence": 1, #optional
12            "sequence": 1, #optional
13            "attributes": [
14                {
15                    "id": "0tjSG0000001embYAA",
16                    "sequence": 1, #optional
17                    "name": "Copay",
18                    "label": "Copay Currency", #optional
19                    "dataType": "CURRENCY",
20                    "keyHidden":false,
21                    "isActive": true
22                },
23                {
24                    "id": "0tjSG0000001eoDYAQ",
25                    "sequence": 1,
26                    "name": "Coinsurance",
27                    "label": "Coinsurance Percentage",
28                    "dataType": "PERCENTAGE",
29                    "keyHidden":false,
30                    "isActive": true
31                }
32            ]
33        }
34    ]
35}

This request shows a sample error response.

1{
2    "isSuccess":false,
3    "errors" : [
4        {
5            "code":INVALID_INPUT,
6            "message": "Specify a valid coverageId."
7        }
8    ]
9}

Property Name	Type	Description	Filter Group and Version	Available Version
`benefits`	Product[]	List of the product component groups and associated attributes.	Small, 63.0	63.0
`errors`	Error Response[]	List of errors during the processing of the API request.	Small, 63.0	63.0
`isSuccess`	Boolean	Indicates whether the API request is successful (`true`) or not (`false`).	Small, 63.0	63.0
`productId`	String	ID of the product for which the benefits are fetched.	Small, 63.0	63.0