---
schema_version: "1"
id: c74d4c3b59a128585e217bca1e580a41eb97fb67ef5a656fd859f2762420a142
title: Cancel Insurance Policy Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/actions_obj_cancel_insurance_policy.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_cancel_insurance_policy.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a1576734d1def9492cb0f331b6c0c23aaa2c848fa402f1e88eb1414bb08b19bd
description: Cancel an insurance policy by using a set of user inputs that represent policy details.
---
# Cancel Insurance Policy Action

Cancel an insurance policy by using a set of user inputs that represent policy details.

This action is available in API version 63.0 and later.

## Supported REST HTTP Methods

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

Where XX.X is the latest API version.

**Formats**: JSON

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d459749e96">Input</th>

              <th class="featureTableHeader  " id="d459749e99">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d459749e96" data-title="Input"><samp class="codeph nolang">cancelPolicyIAInputRep</samp></td>

              <td class="entry" headers="d459749e99" data-title="Details">
                <strong class="ph b">Type</strong>
                <p class="p">Apex-defined</p>
                <p class="p"><strong class="ph b">Description</strong></p>
                <p class="p">An Apex
                  ConnectApi.CancelPolicyIAInputRep record that contains details of the policy to be
                  canceled.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Outputs

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d459749e145">Output</th>

              <th class="featureTableHeader  " id="d459749e148">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d459749e145" data-title="Output"><samp class="codeph nolang">cancelPolicyIAOutputRep</samp></td>

              <td class="entry" headers="d459749e148" data-title="Details">
                <strong class="ph b">Type</strong>
                <p class="p">Apex-defined</p>
                <strong class="ph b">Description</strong>
                <p class="p">An Apex
                  ConnectApi.CancelPolicyIAOutputRep record that contains the details of the policy
                  that's canceled.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Example

Sample Request

{
   "inputs": \[
       {
           "CancelPolicyIAInputRep": {
               "policyId": "0YTxx00000001H3GAI",
               "effectiveDate": "2024-09-08",              
               "transactionRecord":{                            
                   "name": "Cancel Transaction"
               }
           }
       }
   \]
}

Sample Response

{
  "actionName": "cancelInsurancePolicy",
  "errors": null,
  "invocationId": null,
  "isSuccess": true,
  "outcome": null,
  "outputValues": {
    "CancelPolicyIAOutputRep": {
      "impactedPolicyVersions": \[
        "0YTSG000000PgSH4A0"
      \],
      "refund": {
        "premium": "133.4",
        "tax": "21.3",
        "fee": "32.3"
      },
      "sortOrder": -1,
      "version": 1
    }
  }
}