Premium Preview Response

Output representation of the details of the draft-state premium preview results for an insurance policy, including per-node rolled-up amounts and any errors.

JSON Example

This example shows a whole-policy preview success response when references is omitted.

1{
2  "errors": [],
3  "policyId": "0YTfiP000000FdNGBU",
4  "results": [
5    {
6      "amounts": {
7        "standardCommission": 0,
8        "standardFee": 0,
9        "standardPremium": 3000,
10        "standardTax": 0,
11        "termCommission": 0,
12        "termFee": 0,
13        "termPremium": 3000,
14        "termTax": 0,
15        "totalStandard": 3000,
16        "totalTerm": 3000
17      },
18      "errors": [],
19      "name": "Draft State Premium Dummy Policy -1",
20      "recordId": "0YTfiP000000FdNGBU"
21    }
22  ]
23}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	Error Response[]	Error details for the entire request, such as `NOT_FOUND`, batch-limit failures, or proration failures that stop the request. Shows `null` on success.	Small, 68.0	68.0
`policyId`	String	ID of the insurance policy the premium preview is computed for.	Small, 68.0	68.0
`results`	Premium Preview Result []	Per-node computed results in request order. When the `references` parameter is omitted or empty, this list contains a single entry for the policy root. All premium amounts are shown in this list. The response doesn’t include top-level total fields.	Small, 68.0	68.0