Plan Benefits Product Model (GET)

Get the product model details along with child components and their attributes for a given insurance policy coverage.

See Prerequisites to define the product model structure. If this model isn’t followed, the API throws an error.

Note

Resource 

{coverageId} is a placeholder.

1/connect/insurance/brokerage/coverages/{coverageId}/benefits/product

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/coverages/0kPxx000000002fEAA/benefits/product

Available Version 

63.0

HTTP Methods 

GET

Path Parameter for GET 
NameTypeDescriptionRequired or OptionalAvailable Version
coverageIdStringID of insurance policy coverage.Required63.0

Response Body for GET 

Plan Benefits Product Model

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Brokerage Business APIs
Resources
Bulk Cancel Policy (POST)
Bulk Endorse Draft Policy (POST)
Bulk Endorse Policy (POST)
Bulk Issue Policy (POST)
Bulk Reinstate Policy (POST)
Bulk Renew Policy (POST)
Cancel Policy (PATCH)
Commission Processing (POST)
Cost Calculation (PATCH)
Endorse Policy (POST, PATCH)
Expected Revenue (PATCH)
Insurance Billing Schedules (POST)
Issue Policy (PATCH)
Preview Policy Premium (POST)
Plan Benefits (GET, POST, PATCH, DELETE)
Plan Benefits Product Model (GET)
Reinstate Policy (POST)
Renew Policy (POST)
Requests
Responses
Insurance Brokerage Standard Invocable Actions
Insurance Brokerage Metadata API Types
Insurance Brokerage Apex Reference
Insurance Claims Management
Insurance Design Advisor
Insurance Group Benefits
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
Previous PDF Versions