Theme switcher

Create Plan

Header Parameters

Idempotency-Keystring Required

Unique identifier for idempotent requests (UUID v4)

Authorizationstring

Body Parameters

plan_year_idstring Required

Associated plan year ID

parent_plan_idstring

The unique identifier of the parent plan.

Nullable:
True
plan_typestring Required

Type of benefits plan

namestring Required

Internal name of the plan

display_namestring Required

The display name of the plan

form_namestring Required

The form name associated with the plan.

allow_mileage_claimsboolean

Indicates whether mileage claims are allowed.

statusstring

The status of the plan.

enroll_descriptionstring

The enrollment description.

Nullable:
True
plan_rulesstring

The plan rules.

Nullable:
True
plan_descriptionstring

The plan description.

Nullable:
True
require_medical_enrollmentboolean

Indicates whether medical enrollment is required.

require_dental_enrollmentboolean

Indicates whether dental enrollment is required.

require_vision_enrollmentboolean

Indicates whether vision enrollment is required.

cdex_auto_enroll_dependentboolean

Indicates whether dependents are auto-enrolled in CDEX.

cdex_require_ssn_for_dependent_enrollmentboolean

Indicates whether SSN is required for dependent enrollment in CDEX.

maximum_monthly_contributionnumber

The maximum monthly contribution amount.

maximum_total_contributionnumber

The maximum total contribution amount.

minimum_employee_contributionnumber

The minimum employee contribution amount.

contribution_schedule_typestring

The employer contribution schedule type.

individual_employer_contributionnumber

The employer contribution for individual coverage.

individual_and_spouse_employer_contributionnumber

The employer contribution for individual and spouse coverage.

individual_and_dependent_employer_contributionnumber

The employer contribution for individual and dependent coverage.

family_employer_contributionnumber

The employer contribution for family coverage.

maximum_individual_claim_amountnumber

The maximum individual claim amount.

allow_noneligible_claim_day_countinteger

The number of days to allow non-eligible claims.

noneligible_claims_typestring

The type of non-eligible claims allowed.

allow_active_claim_day_countinteger

The number of days to allow active claims.

file_claims_day_countinteger

The number of days allowed to file claims.

reimburse_typestring

The reimbursement type.

allow_automatic_claimsboolean

Indicates whether automatic claims are allowed.

allow_inactive_claimsboolean

Indicates whether inactive claims are allowed.

allow_healthcare_claimsboolean

Indicates whether healthcare claims are allowed.

generate_c_ex_marked_as_paid_extractboolean

Indicates whether to generate CEx marked as paid extract.

plan_orderinteger

The order of the plan.

sort_orderinteger

The sort order of the plan.

is_dependent_planboolean

Indicates whether this is a dependent plan.

extension_datestring Required

The extension date for the plan.

plan_template_idinteger Required

The unique identifier of the plan template.

must_exhaustboolean

Indicates whether the plan must be exhausted.

is_pre_taxboolean

Indicates whether the plan is pre-tax.

medicare_coverage_typestring

The Medicare coverage type.

allow_payroll_frequency_by_classboolean

Indicates whether payroll frequency by class is allowed.

enroll_anytimeboolean

Indicates whether enrollment is allowed anytime.

file_claims_based_onstring

The basis for filing claims.

employer_contribution_typestring

The employer contribution type.

maximum_employee_contributionnumber

The maximum employee contribution amount.

calculate_contribution_scheduleboolean

Indicates whether to calculate contribution schedule.

calculate_payroll_scheduleboolean

Indicates whether to calculate payroll schedule.

generate_contribution_based_auto_claimsboolean

Indicates whether to generate contribution-based auto claims.

Nullable:
True
is_medicare_primary_planboolean

Indicates whether this is a Medicare primary plan.

Nullable:
True

Response

201
Object
Plan created successfully

Response Attributes

dataobject Required

Show child attributes

400
Object
Bad Request

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
409
Object
Conflict - resource already exists

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal Server Error

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot