--- schema_version: "1" id: d29d2966301952429413e264a0fcc0192163cf83593f7f35b5bf72725b0af835 title: PurchaserPlan collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/sforce_api_objects_purchaserplan.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplan.htm source_site: developer.salesforce.com content_type: documentation content_hash: 6c6dfc88502c1ce43214db2e5f99930e0294e81e01b7263be47889fcb782aa47 description: Represents the payer plan that a purchaser makes available to its members and members’ dependents. --- # PurchaserPlan Represents the payer plan that a purchaser makes available to its members and members’ dependents. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### Affiliation - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An affiliation to a government service, such as the army or navy. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this purchaser plan is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this purchaser plan ceases to be effective. ### IsVerifiable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a benefits verification can be performed on this plan. ### LineOfBusiness - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of insurance policy that the purchaser plan belongs to. For example, whether the plan is a group health insurance, individual health insurance, etc. This field is available in API version 64.0 and later. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of this plan. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes about this payer. ### Payer - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the payer’s Account object record. ### PlanNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The plan’s reference number. ### PlanStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the plan is active. ### PlanType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of plan, with the following default options: - PPO - HMO - Medicare - Medicaid - Workers Comp ### ServiceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the service type offered by this plan. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this plan record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this plan record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this plan record was last changed on the source system. ### SponsorType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of sponsor for the plan. For example, if it's self-sponsored, government-sponsored, or company-sponsored. This field is available in API version 64.0 and later. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PurchaserPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_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. [PurchaserPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_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. [PurchaserPlanOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PurchaserPlanShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. [PurchaserPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent 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 data capture is available for this object.