Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Product Administration
Insurance Quoting
Insurance Policy Administration
Insurance Brokerage
Insurance Brokerage Business APIs
Resources
Requests
Cost Calculation Input
Expected Revenue Input
Insurance Commission Processing Input
Insurance Policy Bulk Input
Insurance Policy Renew Input
Plan Benefit Attribute Input
Plan Benefit Input
Plan Benefit Update Input
Networks Input
Update Plan Benefit Input
Responses
Insurance Brokerage Standard Invocable Actions
Insurance Brokerage Metadata API Types
Insurance Brokerage Apex Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Plan Benefit Update Input

Represents details of the plan benefits for an Insurance Policy Coverage.
JSON example
1{
2    "benefits": [
3        {
4            "benefitId": "1HSSG0000005Ws7xxE",
5            "productId": "01tSG0000011yBFxxY",
6            "productCompGgpId": "0y7SG0000000ZiXxxU",
7            "productName": "Chiropractic Care",
8            "attributes": [
9                {
10                    "covBnftAttrId": "1HYSG00000002GPxxY",
11                    "attributeDefinitionId": "0tjSG0000001embxxA",
12                    "name": "Copay",
13                    "value": 311
14                },
15                {
16                    "covBnftAttrId": "1HYSG00000002GQxxY",
17                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
18                    "name": "Notes",
19                    "value": "Preferred network limitations apply."
20                }
21            ]
22        }
23    ]
24}
Properties
Name Type Description Required or Optional Available Version
benefitId String ID of the Insurance Policy Coverage Benefit. Required 63.0
productId String ID of the product. Optional 63.0
productCompGgpId String ID of product component group Optional 63.0
productName String Name of the product. Optional 63.0
network String The tier type of the network. Optional 63.0
attributes String List of attributes. Optional 63.0
covBnftAttrId String ID of Insurance Policy Coverage Benefit Attribute. Required 63.0
name String Name of the attribute. Optional 63.0
value String Value of the attribute. Optional 63.0
attributeDefinitionId String ID of the Attribute Definition. Optional 63.0