InsuranceRatePlan

Represents a rate plan for an employee's insurance. This object is available in API version 61 and later.

Supported Calls

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

Fields

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:
    • EUR—Euro
    • GBP—British Pound
    • USD—U.S. Dollar

ExpectedRevenueAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The revenue amount that the brokerage is expected to earn from the rate plan.

Frequency

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the frequency of premium, fees, or premium equivalents for the insurance under specified rate plan.
  • Possible values:
    • Annually
    • Monthly
    • Quarterly

GeoStateId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The location where the rate plan is applicable.

    This field is a relationship field.

  • Relationship Name: GeoState
  • Refers To: GeoState

InsurancePolicyCoverageId

  • Details: The insurance policy coverage associated with the rate plan.

InsurancePolicyId

  • Details: The insurance policy associated with the rate plan.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the rate plan.

TotalFeeAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total fee amount for the rate plan.

TotalPremiumAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total premium amount of the insurance for the specified rate plan.

TotalPremiumEqvAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total premium equivalent amount that's used for a fully insured equivalent rate plan.

Type

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the type of insurance rate plan that determines the calculation method for premium, fee, or premium equivalent

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.

InsuranceRatePlanChangeEvent
Change events are available for the object in API version 62.0 and later.
InsuranceRatePlanHistory
History is available for tracked fields of the object.
InsuranceRatePlanOwnerSharingRule
Sharing rules are available for the object.
InsuranceRatePlanShare
Sharing is available for the object.