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.
{
    "isSuccess":true,
    "errors":[],
    "productId": "01tSG0000013itZYAQ",
    "benefits": [
        {
            "id": "01tSG0000011y9dYAA",
            "name": "Annual deductible/Individual",
            "componentGroupId": "0y7SG0000000Q8zYAE",
            "componentGroupName": "General plan information",
            "componentGroupSequence": 1, #optional
            "sequence": 1, #optional
            "attributes": [
                {
                    "id": "0tjSG0000001embYAA",
                    "sequence": 1, #optional
                    "name": "Copay",
                    "label": "Copay Currency", #optional
                    "dataType": "CURRENCY",
                    "keyHidden":false,
                    "isActive": true
                },
                {
                    "id": "0tjSG0000001eoDYAQ",
                    "sequence": 1,
                    "name": "Coinsurance",
                    "label": "Coinsurance Percentage",
                    "dataType": "PERCENTAGE",
                    "keyHidden":false,
                    "isActive": true
                }
            ]
        }
    ]
}
This request shows a sample error response.
{
    "isSuccess":false,
    "errors" : [
        {
            "code":INVALID_INPUT,
            "message": "Specify a valid coverageId."
        }
    ]
}
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