Input representation for a single plan or coverage for a group census
member.
JSON Example
{
"contractGroupPlanId": "0s1xx000000001aEAA",
"name": "Gold Tier Medical Plan",
"attributes": {
"values": [
{
"attributeCode": "Deductible",
"attributeValue": "0"
}
]
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| attributes | Attribute Input [] | List of attribute-level changes that you want to make for the specific off-contract plan or coverage. Use this parameter to define custom values for individual plan attributes, such as deductibles, co-pays, or waiting periods, that differ from the base Product2 definition. | Optional | 68.0 |
| contractGroupPlanId | String | ID of the contract group plan. | Required | 65.0 |
| groupCensusMemberId | String | ID of the group census member. | Optional | 65.0 |
| id | String | ID of the group census member plan record. | Required to update plan | 65.0 |
| name | String | Name of the group census member plan. | Optional | 65.0 |
| productCode | String | Product code of the Product2 record for the off-contract coverage overrides. Use this parameter to add a coverage that doesn’t exist in the member’s assigned contract group plan. | Required if contractGroupPlanId isn’t specified | 68.0 |
| rootProductCode | String | Product code of the root product to which the off-contract coverage (defined by productCode) belongs. | Required if productCode is specified | 68.0 |