Preview Policy Premium (POST)

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

Use this resource when you want to preview the premium on a policy or any child objects before issuing the policy. The API prorates and rolls up amounts in memory for the requested hierarchy nodes and returns the results. It doesn’t write roll-up fields, create insurance policy transactions, or trigger billing. Omit references to preview premium amounts only for the root policy. This API supports up to 2000 reference record IDs.

Resource

{policyId} is a placeholder.

/connect/insurance/brokerage/policies/{policyId}/premium-preview

Resource Example

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

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx000000004rGAA/premium-preview

Available Version

68.0

HTTP Methods

POST

Path Parameter for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`policyId`	String	ID of the insurance policy to preview premiums for. The key prefix is `0YT`.	Required	68.0

Request Body for POST

JSON Example

{
  "references": {
    "references": [
      {
        "recordId": "0cYxx00000000ODEAY"
      },
      {
        "recordId": "0cYxx00000000MbEAI"
      }
    ]
  }
}

Properties

Name	Type	Description	Required or Optional	Available Version
`references`	Premium Preview Reference Input[]	List of hierarchy-node references to compute. If omitted or empty, the API returns only the root policy level amounts. Supports up to 2000 node references. Results are returned in the same order as this list.	Optional	68.0

Response Body for POST

Premium Preview Response