---
schema_version: "1"
id: 20ff86bae90391f6abcc2b0d55030ae8466de6d3d5131562e9c2a2c14b927e78
title: Plan Benefits (GET, POST, PATCH, DELETE)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/connect_resources_plan_benefits.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_plan_benefits.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 37cf586665e35fd3ce2f2cbc4705dbcff86aa6d32cb3e0521e5850b3f12187be
description: Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage.
---
# Plan Benefits (GET, POST, PATCH, DELETE)

Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage.

## Resource

{coverageId} is a placeholder.

/connect/insurance/brokerage/coverages/{coverageId}/benefits

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/coverages/0kPxx000000002fEAA/benefits

## Available Version

63.0

## HTTP Methods

GET, POST, PATCH, DELETE

## Response Body for GET

[Plan Benefits Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_plan_benefits.htm "Output representation details of the insurance policy benefits.")

## Request Body for POST

### JSON Example

{
    "networks": \[
        {
            "network": "First Network Tier",
            "name": "Preferred Network"
        },
        {
            "network": "Second Network Tier",
            "name": "In Network"
        }
    \],
    "benefits": \[
        {
            "productId": "01tSG0000011yBFxxY",
            "productCompGgpId": "0y7SG0000000ZiXxxU",
            "productName": "Chiropractic Care",
            "network": "First Network Tier",
            "attributes": \[
                {
                    "attributeDefinitionId": "0tjSG0000001embxxA",
                    "name": "Copay",
                    "value": 311
                },
                {
                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
                    "name": "Deductible",
                    "value": "100"
                }
            \]
        }
    \]
}

### Properties

| Name | Type | Descriptions | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| attributes | [Benefit Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_attribute_input.htm "Represents details of the plan benefits attributes for an Insurance Policy Coverage.") | List of benefit attributes. | Optional | 63.0 |
| network | String | The tier type of the network. | Optional | 63.0 |
| networks | [Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | Insurance Policy Coverage Networks for creating plan benefits. | Required | 63.0 |
| productCompGgpId | String | ID of product component group. | Optional | 63.0 |
| productId | String | ID of the product. | Required | 63.0 |
| productName | String | Name of the product. | Optional | 63.0 |

## Response Body for POST

[Plan Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_plan_benefit_output.htm "Output representation details of the create and update plan benefits request.")

## Request Body for PATCH

### JSON Example

{
    "networks": \[
        {
            "networkId": "1HXSG0000002xxxxAM",
            "name": "Preferred Network Updated"
        },
        {
            "networkId": "1HXSG0000002xxxxA2",
            "name": "In Network Updated"
        },
        {
            "network": "Third Network Tier",
            "name": "Out Network"
        }
    \],
    "benefits": \[
        {
            "benefitId": "1HSSG0000005Ws7xxE",
            "productId": "01tSG0000011yBFxxY",
            "productCompGgpId": "0y7SG0000000ZiXxxU",
            "productName": "Chiropractic Care",
            "attributes": \[
                {
                    "covBnftAttrId": "1HYSG00000002GPxxY",
                    "attributeDefinitionId": "0tjSG0000001embxxA",
                    "name": "Copay",
                    "value": 311
                },
                {
                    "covBnftAttrId": "1HYSG00000002GQxxY",
                    "attributeDefinitionId": "0tjSG0000001YmMxxU",
                    "name": "Notes",
                    "value": "Preferred network limitations apply."
                }
            \]
        }
    \]
}

### Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| benefits | [Benefits Input \[\]](connect_requests_plan_benefit_update_input.htm "Represents details of the plan benefits for an Insurance Policy Coverage.") | The benefits of the Insurance Plan Coverage. | Optional | 63.0 |
| networks | [Networks Input \[\]](connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | The list of networks. | Optional | 63.0 |

## Response Body for PATCH

[Plan Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_plan_benefit_output.htm "Output representation details of the create and update plan benefits request.")

## Request Parameters for DELETE

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| benefitIds | String\[\] | IDs of Insurance Policy Coverage Benefit. If benefitIds are provided, the service will only delete the respective Insurance Policy Coverage Benefit records. | Optional | 63.0 |
| networkIds | String\[\] | IDs of the Insurance Policy Coverage Network. IfnetworkIds are provided, the service will only delete the respective Insurance Policy Coverage Network records and their associated Insurance Policy Coverage Benefit records. | Optional | 63.0 |