vericred_client 0.0.11 → 0.0.18

data/docs/DentalPlanShowResponse.md

@@ -0,0 +1,8 @@
+# VericredClient::DentalPlanShowResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dental_plan** | [**DentalPlan**](DentalPlan.md) | Dental Plan response | [optional] 
+
+

data/docs/DentalPlanUpdate.md

@@ -0,0 +1,16 @@
+# VericredClient::DentalPlanUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The dental plan name | [optional] 
+**issuer_vericred_id** | **String** | The issuer vericred id | [optional] 
+**audience** | **String** | The dental plan audience | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**plan_type** | **String** | The dental plan type | [optional] 
+**stand_alone** | **BOOLEAN** | Stand alone flag for dental plan | [optional] 
+**source** | **String** | The dental plan source | [optional] 
+**external_ids** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | Dental Plan External Identifiers | [optional] 
+**benefits** | [**DentalPlanBenefits**](DentalPlanBenefits.md) | Dental Plan Benefits | [optional] 
+
+

data/docs/DentalPlanUpdateRequest.md

@@ -0,0 +1,8 @@
+# VericredClient::DentalPlanUpdateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dental_plan** | [**DentalPlanUpdate**](DentalPlanUpdate.md) | Dental Plan | [optional] 
+
+

data/docs/DentalPlansApi.md

@@ -0,0 +1,174 @@
+# VericredClient::DentalPlansApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_dental_plan**](DentalPlansApi.md#delete_dental_plan) | **DELETE** /plans/dental/{vericred_id} | Delete a Dental Plan.
+[**put_dental_plan**](DentalPlansApi.md#put_dental_plan) | **PUT** /plans/dental/{vericred_id} | Create/update a Dental Plan
+[**show_dental_plan**](DentalPlansApi.md#show_dental_plan) | **GET** /plans/dental/{vericred_id} | Show Plan
+
+
+# **delete_dental_plan**
+> delete_dental_plan(vericred_id)
+
+Delete a Dental Plan.
+
+Delete a Dental Plan from the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::DentalPlansApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+
+begin
+  #Delete a Dental Plan.
+  api_instance.delete_dental_plan(vericred_id)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling DentalPlansApi->delete_dental_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_dental_plan**
+> put_dental_plan(vericred_id, body)
+
+Create/update a Dental Plan
+
+Add or update a Dental Plan to the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::DentalPlansApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+body = VericredClient::DentalPlanUpdateRequest.new # DentalPlanUpdateRequest | Dental Plan Record
+
+
+begin
+  #Create/update a Dental Plan
+  api_instance.put_dental_plan(vericred_id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling DentalPlansApi->put_dental_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+ **body** | [**DentalPlanUpdateRequest**](DentalPlanUpdateRequest.md)| Dental Plan Record | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **show_dental_plan**
+> DentalPlanShowResponse show_dental_plan(id)
+
+Show Plan
+
+Show the details of a DentalPlan.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::DentalPlansApi.new
+
+id = "88582NY0230001" # String | ID of the Plan
+
+
+begin
+  #Show Plan
+  result = api_instance.show_dental_plan(id)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling DentalPlansApi->show_dental_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Plan | 
+
+### Return type
+
+[**DentalPlanShowResponse**](DentalPlanShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DrugCoverage.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **plan_id** | **String** | Health Insurance Oversight System id | [optional] 
 **drug_package_id** | **String** | NDC package code | [optional] 
 **med_id** | **Integer** | Med ID | [optional] 
+**drug_ids** | **Array<String>** | Vericred-generated IDs for drugs | [optional] 
 **quantity_limit** | **BOOLEAN** | Quantity limit exists | [optional] 
 **prior_authorization** | **BOOLEAN** | Prior authorization required | [optional] 
 **step_therapy** | **BOOLEAN** | Step Treatment required | [optional] 

data/docs/DrugCoverageResponse.md

@@ -5,7 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
 **drug_coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | DrugCoverage search results | [optional] 
-**drugs** | [**Array<Drug>**](Drug.md) | Drug | [optional] 
-**drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | Drug Packages | [optional] 
+**drug** | [**Drug**](Drug.md) | Drug | [optional] 
 
 

data/docs/EmbargoRequest.md

@@ -0,0 +1,13 @@
+# VericredClient::EmbargoRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The external name of the Embargo Date | [optional] 
+**product_line** | **String** | The product line for the Embargo Date | [optional] 
+**audience** | **String** | The audience for the Embargo Date | [optional] 
+**release_date** | **String** | The date for which the embargo ends | [optional] 
+**start_date** | **String** | The effective date for which the embargo applies | [optional] 
+**end_date** | **String** | The expiration date for which the embargo applies | [optional] 
+
+

data/docs/EmbargoesApi.md

@@ -0,0 +1,119 @@
+# VericredClient::EmbargoesApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_embargo**](EmbargoesApi.md#delete_embargo) | **DELETE** /embargoes/{vericred_id} | Delete an Embargo.
+[**put_embargo**](EmbargoesApi.md#put_embargo) | **PUT** /embargoes/{vericred_id} | Create/update an Embargo
+
+
+# **delete_embargo**
+> delete_embargo(vericred_id)
+
+Delete an Embargo.
+
+Delete an Embargo from the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::EmbargoesApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+
+begin
+  #Delete an Embargo.
+  api_instance.delete_embargo(vericred_id)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling EmbargoesApi->delete_embargo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_embargo**
+> put_embargo(vericred_id, body)
+
+Create/update an Embargo
+
+Add or update an Embargo to the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::EmbargoesApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+body = VericredClient::EmbargoRequest.new # EmbargoRequest | Embargo Record
+
+
+begin
+  #Create/update an Embargo
+  api_instance.put_embargo(vericred_id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling EmbargoesApi->put_embargo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+ **body** | [**EmbargoRequest**](EmbargoRequest.md)| Embargo Record | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/FormulariesApi.md

@@ -0,0 +1,70 @@
+# VericredClient::FormulariesApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_formularies**](FormulariesApi.md#list_formularies) | **GET** /formularies | Formulary Search
+
+
+# **list_formularies**
+> FormularyResponse list_formularies(opts)
+
+Formulary Search
+
+Search for drugs by proprietary name
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::FormulariesApi.new
+
+opts = { 
+  search_term: "HIX PPO", # String | Full or partial name of the formulary
+  rx_bin: "123456", # String | RX BIN Number (found on an insurance card)
+  rx_group: "HEALTH", # String | RX Group String (found on an insurance card)
+  rx_pcn: "9999" # String | RX PCN Number (found on an insurance card)
+}
+
+begin
+  #Formulary Search
+  result = api_instance.list_formularies(opts)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling FormulariesApi->list_formularies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_term** | **String**| Full or partial name of the formulary | [optional] 
+ **rx_bin** | **String**| RX BIN Number (found on an insurance card) | [optional] 
+ **rx_group** | **String**| RX Group String (found on an insurance card) | [optional] 
+ **rx_pcn** | **String**| RX PCN Number (found on an insurance card) | [optional] 
+
+### Return type
+
+[**FormularyResponse**](FormularyResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/IssuerRequest.md

@@ -0,0 +1,19 @@
+# VericredClient::IssuerRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issuer_id_type** | **String** | The issuer id type | [optional] 
+**issuer_id** | **String** | The issuer id | [optional] 
+**name** | **String** | The name of the Carrier | [optional] 
+**carrier_vericred_id** | **String** | The parent carrier group vericred id | [optional] 
+**address_line_1** | **String** | First line of issuer street address | [optional] 
+**address_line_2** | **String** | Second line of issuer street address | [optional] 
+**state_code** | **String** | The state code of the Carrier | [optional] 
+**city** | **String** | The city for the issuer address | [optional] 
+**zip_code** | **String** | The zip code of the issuer | [optional] 
+**licensed_state_code** | **String** | The licensed state code of the Issuer | [optional] 
+**brand_name** | **String** | The brand name of the Carrier | [optional] 
+**source_logo_url** | **String** | url of logo to be associated with issuer | [optional] 
+
+

data/docs/IssuersApi.md

@@ -0,0 +1,119 @@
+# VericredClient::IssuersApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_issuer**](IssuersApi.md#delete_issuer) | **DELETE** /issuers/{vericred_id} | Delete an Issuer.
+[**put_issuer**](IssuersApi.md#put_issuer) | **PUT** /issuers/{vericred_id} | Create/update an Issuer
+
+
+# **delete_issuer**
+> delete_issuer(vericred_id)
+
+Delete an Issuer.
+
+Delete an Issuer from the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::IssuersApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+
+begin
+  #Delete an Issuer.
+  api_instance.delete_issuer(vericred_id)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling IssuersApi->delete_issuer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_issuer**
+> put_issuer(vericred_id, body)
+
+Create/update an Issuer
+
+Add or update an Issuer to the database.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::IssuersApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+body = VericredClient::IssuerRequest.new # IssuerRequest | Issuer Record
+
+
+begin
+  #Create/update an Issuer
+  api_instance.put_issuer(vericred_id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling IssuersApi->put_issuer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+ **body** | [**IssuerRequest**](IssuerRequest.md)| Issuer Record | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/MedicalPlansApi.md

@@ -0,0 +1,122 @@
+# VericredClient::MedicalPlansApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find_plans**](MedicalPlansApi.md#find_plans) | **POST** /plans/medical/search | Find Plans
+[**show_plan**](MedicalPlansApi.md#show_plan) | **GET** /plans/medical/{id} | Show Plan
+
+
+# **find_plans**
+> PlanSearchResponse find_plans(body)
+
+Find Plans
+
+### Location Information  Searching for a set of plans requires a `zip_code` and `fips_code` code.  These are used to determine pricing and availabity of health plans. This endpoint is paginated.  Optionally, you may provide a list of Applicants or Providers  ### Applicants  This is a list of people who will be covered by the plan.  We use this list to calculate the premium.  You must include `age` and can include `smoker`, which also factors into pricing in some states.  Applicants *must* include an age.  If smoker is omitted, its value is assumed to be false.  #### Multiple Applicants To get pricing for multiple applicants, just append multiple sets of data to the URL with the age and smoking status of each applicant next to each other.  For example, given two applicants - one age 32 and a non-smoker and one age 29 and a smoker, you could use the following request  `GET /plans/medical?zip_code=07451&fips_code=33025&applicants[][age]=32&applicants[][age]=29&applicants[][smoker]=true`  It would also be acceptible to include `applicants[][smoker]=false` after the first applicant's age.  ### Providers  We identify Providers (Doctors) by their National Practitioner Index number (NPI).  If you pass a list of Providers, keyed by their NPI number, we will return a list of which Providers are in and out of network for each plan returned.  For example, if we had two providers with the NPI numbers `12345` and `23456` you would make the following request  `GET /plans/medical?zip_code=07451&fips_code=33025&providers[][npi]=12345&providers[][npi]=23456`  ### Enrollment Date  To calculate plan pricing and availability, we default to the current date as the enrollment date.  To specify a date in the future (or the past), pass a string with the format `YYYY-MM-DD` in the `enrollment_date` parameter.  `GET /plans/medical?zip_code=07451&fips_code=33025&enrollment_date=2016-01-01`  ### Subsidy  On-marketplace plans are eligible for a subsidy based on the `household_size` and `household_income` of the applicants.  If you pass those values, we will calculate the `subsidized_premium` and return it for each plan.  If no values are provided, the `subsidized_premium` will be the same as the `premium`  `GET /plans/medical?zip_code=07451&fips_code=33025&household_size=4&household_income=40000`   ### Sorting  Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc`) sort under the `sort` field.  For example, to sort plans by level, the sort parameter would be `level:asc`.  ### Drug coverages  Are included along with the rest of the plan data. See [the description below](#drugcoverages) for more details. 
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::MedicalPlansApi.new
+
+body = VericredClient::RequestPlanFind.new # RequestPlanFind | 
+
+
+begin
+  #Find Plans
+  result = api_instance.find_plans(body)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling MedicalPlansApi->find_plans: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RequestPlanFind**](RequestPlanFind.md)|  | 
+
+### Return type
+
+[**PlanSearchResponse**](PlanSearchResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **show_plan**
+> PlanShowResponse show_plan(id, opts)
+
+Show Plan
+
+Show the details of an individual Plan.  This includes deductibles, maximums out of pocket, and co-pay/coinsurance for benefits (See [Benefits summary format](#header-benefits-summary-format) above.)
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::MedicalPlansApi.new
+
+id = "88582NY0230001" # String | ID of the Plan
+
+opts = { 
+  year: 2018 # Integer | Plan year (defaults to current year)
+}
+
+begin
+  #Show Plan
+  result = api_instance.show_plan(id, opts)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling MedicalPlansApi->show_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Plan | 
+ **year** | **Integer**| Plan year (defaults to current year) | [optional] 
+
+### Return type
+
+[**PlanShowResponse**](PlanShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+