Newer Version Available

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

Get Member Ratings and Contributions Action

Get standard and prorated insurance rates for the specified group census members and their selected plan coverages, including contributions.

This action retrieves member-specific coverage selections, validates them against the root plan hierarchy, and invokes the rating service to calculate premiums and contributions. The action returns pricing results with rates at member, plan, and coverage levels, along with hierarchical error information. The action is currently used in enrollment flows.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/v66.0/actions/standard/getMbrsRatingAndContribution
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
groupCensusMembers
Type
sobject
Description

Required.

Collection of group census member records for whom rates must be calculated.

This action retrieves the member IDs from these records.

The maximum list size is 2000.

contractGroupPlanId
Type
string
Description

Required.

ID of the root contract group plan for which the rates and contributions must be calculated. This ID represents the primary plan under which coverages are organized.

The action validates that selected coverages that belong to this plan hierarchy.

effectiveDate
Type
date
Description
Effective date for rating calculations in yyyy-MM-dd format. If specified, the rating service uses this date to lookup the active pricing procedure and perform proration calculations. If not specified, contract start date is used as default.

Outputs

Output Details
memberRatingOutputRep
Type
Apex-defined
Description
An Apex ind_ins_grpben__MembersPlansRatingOutput record that contains pricing results for the requested members, plans, and coverages.
The Apex class includes standard rates, prorated rates, contributions, and hierarchical error information at the request, member, plan, and coverage levels.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "groupCensusMembers": [
5        {
6          "Id": "0r6SG0000008OFjYAM",
7          "Name": "John Doe",
8          "FirstName": "John",
9          "LastName": "Doe",
10          "Email": "john.doe@example.com",
11          "BirthDate": "1985-03-15"
12        },
13        {
14          "Id": "0r6SG0000008OFjYAN",
15          "Name": "Jane Smith",
16          "FirstName": "Jane",
17          "LastName": "Smith",
18          "Email": "jane.smith@example.com",
19          "BirthDate": "1990-07-22"
20        }
21      ],
22      "contractGroupPlanId": "0rgSG0000000ef1YAA",
23      "effectiveDate": "2025-10-15"
24    }
25  ]
26}

Sample Response

1[
2  {
3    "actionName": "getMbrsRatingAndContributions",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "memberRatingOutputRep": {
10        "pricingResults": [
11          {
12            "plans": [
13              {
14                "rates": [
15                  {
16                    "value": 60,
17                    "key": "NetUnitPrice"
18                  }
19                ],
20                "proratedRates": [
21                  {
22                    "value": 60,
23                    "key": "NetUnitPrice"
24                  }
25                ],
26                "planId": "0rgSG0000000eezYAA",
27                "errors": [],
28                "coverages": [
29                  {
30                    "rates": [
31                      {
32                        "value": 20,
33                        "key": "NetUnitPrice"
34                      }
35                    ],
36                    "proratedRates": [
37                      {
38                        "value": 20,
39                        "key": "NetUnitPrice"
40                      }
41                    ],
42                    "errors": [],
43                    "coverageId": "0rgSG0000000ef1YAA",
44                    "contributions": {
45                      "groupClassContributionId": "0rFSG0000000Beb2AE",
46                      "errors": [],
47                      "employerPremiumAmount": 2,
48                      "employeePremiumAmount": 18
49                    }
50                  }
51                ],
52                "contributions": {
53                  "groupClassContributionId": null,
54                  "errors": [],
55                  "employerPremiumAmount": 2,
56                  "employeePremiumAmount": 58
57                }
58              }
59            ],
60            "memberId": "0r6SG0000008R33YAE",
61            "errors": []
62          }
63        ],
64        "errors": []
65      }
66    },
67    "sortOrder": -1,
68    "version": 1
69  }
70]