---
schema_version: "1"
id: 87b4ca14144523beb7805c6139f24462d1eef1f5e8e6388098e79f72c2fe1aa8
title: Preview Policy Premium Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/actions_obj_preview_policy_premium.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_preview_policy_premium.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 02d445198d6d0236e6a52701622d1978ef446185cbb4effbf6829a802bd9f055
description: Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes.
---
# Preview Policy Premium Action

Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes.

This action is available in API version 68.0 and later.

## Supported REST HTTP Methods

**URI**: /services/data/vXX.X/actions/standard/previewPolicyPremium

Where XX.X is the latest API version.

**Formats**: JSON, XML

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

| Input | Type | Description |
| --- | --- | --- |
| previewPolicyPremiumInputRepresentation | Apex-defined | Required. An Apex ConnectApi.PreviewPolicyPremiumIAInputRep record that contains the details to calculate and preview the premium amounts for the specified policy ID. |

## Outputs

| Output | Type | Description |
| --- | --- | --- |
| previewPolicyPremiumOutputRepresentation | Apex-defined | An Apex ConnectApi\_\_PreviewPolicyPremiumIAOutputRep record that contains the policy premium details for preview. |

## Example

**POST**

This sample request is for the Preview Policy Premium action when references isn't specified.

{
  "inputs": \[
    {
      "previewPolicyPremiumInputRepresentation": {
        "insurancePolicyId": "0YTxx00000000CvGAI"
      }
    }
  \]
}

This sample response is for the Preview Policy Premium action when references isn't specified in the request.

\[
  {
    "actionName": "previewPolicyPremium",
    "errors": null,
    "expectedError": false,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "previewPolicyPremiumOutputRepresentation": {
        "policyId": "0YTfiP000000FdNGBU",
        "results": \[
          {
            "amounts": {
              "standardCommission": 0,
              "standardFee": 0,
              "standardPremium": 3000,
              "standardTax": 0,
              "termCommission": 0,
              "termFee": 0,
              "termPremium": 3000,
              "termTax": 0,
              "totalStandard": 3000,
              "totalTerm": 3000
            },
            "errors": \[\],
            "name": "Draft State Premium Dummy Policy -1",
            "recordId": "0YTfiP000000FdNGBU"
          }
        \]
      }
    },
    "sortOrder": -1,
    "version": 1
  }
\]

This sample request is for the Preview Policy Premium action with references included in the request.

{
  "inputs": \[
    {
      "previewPolicyPremiumInputRepresentation": {
        "insurancePolicyId": "0YTfiP000000FdNGBU",
        "references": {
          "references": \[ { "recordId": "0YTfiP000000FdNGBU" } \]
        }
      }
    }
  \]
}

This sample response is for the Preview Policy Premium action when references is specified in the request.

\[
  {
    "actionName": "previewPolicyPremium",
    "errors": null,
    "expectedError": false,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "previewPolicyPremiumOutputRepresentation": {
        "policyId": "0YTfiP000000FdNGBU",
        "results": \[
          {
            "amounts": {
              "standardCommission": 0,
              "standardFee": 0,
              "standardPremium": 3000,
              "standardTax": 0,
              "termCommission": 0,
              "termFee": 0,
              "termPremium": 3000,
              "termTax": 0,
              "totalStandard": 3000,
              "totalTerm": 3000
            },
            "errors": \[\],
            "name": "Draft State Premium Dummy Policy -1",
            "recordId": "0YTfiP000000FdNGBU"
          }
        \]
      }
    },
    "sortOrder": -1,
    "version": 1
  }
\]