---
schema_version: "1"
id: 9726f32755b859058c5c83e3080ba396244db3e9ce09e160681dafcb37367600
title: ClaimPayoutPlan
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/sforce_api_objects_claimpayoutplan.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_claimpayoutplan.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 3c93add932963904c61f8e3c774f4b1a04302f0b1fec247405de2a29d3ba7c78
description: Represents the payout plan details for a claim, such as payment frequency, duration, and payouts. This object is available in API version 56.0 and later.
---
# ClaimPayoutPlan

Represents the payout plan details for a claim, such as payment frequency, duration, and payouts. This object is available in API version 56.0 and later.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Fields

### ClaimId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The claim associated with the claim payout plan.
    
    This field is a relationship field.
- **Relationship Name**: Claim
- **Relationship Type**: Lookup
- **Refers To**: Claim

### CurrencyIsoCode

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
- **Default value**: USD
- **Possible values**:
    - AED—UAE Dirham
    - CAD—Canadian Dollar
    - GBP—British Pound
    - JPY—Japanese Yen
    - USD—U.S. Dollar

### EndDate

- **Type**: date
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The date the claim payout plan ends.

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The timestamp when the current user last viewed this record or list view.

### Name

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Sort, Update
- **Description**: Name of the claim payout plan.

### PaymentFrequency

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: Specifies the frequency of the payment if the coverage entails a recurring payout to the insured.
- **Possible values**:
    - Bi-Weekly
    - Monthly
    - Weekly
    - Yearly

### PlannedPaymentAmount

- **Type**: currency
- **Properties**: Create, Filter, Sort, Update
- **Description**: The amount paid to the party at each payout.

### PreviousClaimPayoutPlanId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The previous payout plan associated with the claim payout plan.
    
    This field is a relationship field.
- **Relationship Name**: PreviousClaimPayoutPlan
- **Relationship Type**: Lookup
- **Refers To**: ClaimPayoutPlan

### StartDate

- **Type**: date
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The date the claim payout plan starts.

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[ClaimPayoutPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")

Change events are available for the object in API version 63.0 and later.

[ClaimPayoutPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[ClaimPayoutPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.