--- schema_version: "1" id: ccec78f5be6dd7b83106d4f590c0d2965dfb6cc5fe074adc03f1a97d8e150269 title: ContractGroupPlan 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_contractgroupplan.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_contractgroupplan.htm source_site: developer.salesforce.com content_type: documentation content_hash: b0ec8f4936554b97b73e15799f2f3fca67fc3567dc7e7597dab158cc2223f882 description: Represents a set of plans as part of the contract between the insurance carrier and the group. This set of plans corresponds to the plans included in the quote (as Quote Line Items). Child object of Contract. This object is available in API version 55.0 and later. --- # ContractGroupPlan Represents a set of plans as part of the contract between the insurance carrier and the group. This set of plans corresponds to the plans included in the quote (as Quote Line Items). Child object of Contract. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The group account associated with the contract group plan. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ContractGroupParentPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contract group parent plan associated with the contract group plan. This is a relationship field. - **Relationship Name**: ContractGroupParentPlan - **Relationship Type**: Lookup - **Refers To**: ContractGroupPlan ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract associated with the contract group plan. This is a relationship field. - **Relationship Name**: Contract - **Relationship Type**: Lookup - **Refers To**: Contract ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The effective end date of the plan line item. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The effective start date of the plan line item. ### EligibilityCriteria - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The eligibility criteria for the contract group plan. ### EnrollmentEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when enrollment ends for the plans in the contract. ### EnrollmentRatingType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the enrollment rating type. - **Possible values**: - Composite - Rate ### EnrollmentStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when enrollment starts for the plans in the insurance contract. ### EnrollmentWaitingPeriod - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The waiting period in days after joining date before enrollment can begin. ### GroupNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The group number associated with the group account. Required for the enrollment process. ### IsOptional - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the coverage product plan is optional (true) or mandatory (false). - **Default value**: false ### 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**: The name of the contract group plan. ### OriginalContractPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The original contract plan associated with the contract group plan. This is a relationship field. - **Relationship Name**: OriginalContractPlan - **Relationship Type**: Lookup - **Refers To**: ContractGroupPlan ### PlanType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the category for each contract plan. ### PricingStructure - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The structure of pricing based on the rate band tiers. ### ProductNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product number associated with a contract group plan. ### QuoteLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quote line item associated with the contract group plan. This is a relationship field. - **Relationship Name**: QuoteLineItem - **Relationship Type**: Lookup - **Refers To**: QuoteLineItem ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the group contract plan. - **Possible values**: - Active - Inactive ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of the contract group plan. ### UsageType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Internal field. Specifies the application using the group census to populate data. For example, Insurance or Loyalty. - **Default value**: Insurance - **Possible values**: - Insurance ## 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. [ContractGroupPlanChangeEvent](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 62.0 and later. [ContractGroupPlanFeed](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. [ContractGroupPlanHistory](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.