Create Plan
Header Parameters
Required client-generated UUID v4 used to deduplicate retried mutating requests (POST, PUT, PATCH, DELETE). Requests without this header are rejected with 400 Bad Request. The first successful (2xx) response is cached for 24h and replays of the same key return the cached response without re-executing the operation.
Body Parameters
Associated plan year ID
The unique identifier of the parent plan.
Type of benefits plan
Internal name of the plan
The display name of the plan
The form name associated with the plan.
Indicates whether mileage claims are allowed.
The status of the plan.
The enrollment description.
The plan rules.
The plan description.
Indicates whether medical enrollment is required.
Indicates whether dental enrollment is required.
Indicates whether vision enrollment is required.
Indicates whether dependents are auto-enrolled in CDEX.
Indicates whether SSN is required for dependent enrollment in CDEX.
The maximum monthly contribution amount.
The maximum total contribution amount.
The minimum employee contribution amount.
The employer contribution schedule type.
The employer contribution for individual coverage.
The employer contribution for individual and spouse coverage.
The employer contribution for individual and dependent coverage.
The employer contribution for family coverage.
The maximum individual claim amount.
The number of days to allow non-eligible claims.
The type of non-eligible claims allowed.
The number of days to allow active claims.
The number of days allowed to file claims.
The reimbursement type.
Indicates whether automatic claims are allowed.
Indicates whether inactive claims are allowed.
Indicates whether healthcare claims are allowed.
Indicates whether to generate CEx marked as paid extract.
The order of the plan.
The sort order of the plan.
Indicates whether this is a dependent plan.
The extension date for the plan.
The unique identifier of the plan template.
Indicates whether the plan must be exhausted.
Indicates whether the plan is pre-tax.
The Medicare coverage type.
Indicates whether payroll frequency by class is allowed.
Indicates whether enrollment is allowed anytime.
The basis for filing claims.
The employer contribution type.
The maximum employee contribution amount.
Indicates whether to calculate contribution schedule.
Indicates whether to calculate payroll schedule.
Indicates whether to generate contribution-based auto claims.
Indicates whether this is a Medicare primary plan.
Response
Plan created successfully
Response Attributes
ETag value for optimistic locking. Use this value in the If-Match header for subsequent update requests.
Show child attributes
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Show child attributes
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Conflict – Returned for duplicate-record conflicts and optimistic concurrency version mismatches. See duplicate_record and version_conflict examples.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.