Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 6.11 KB

PlansApi.md

File metadata and controls

112 lines (76 loc) · 6.11 KB
Raw

Vericred\Client\PlansApi

All URIs are relative to https://api.vericred.com/

Method HTTP request Description
findPlans POST /plans/search Find Plans
showPlan GET /plans/{id} Show Plan

findPlans

\Swagger\Client\Model\PlanSearchResponse findPlans($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?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?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?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?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 for more details.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Vericred-Api-Key
Vericred\Client\Configuration::getDefaultConfiguration()->setApiKey('Vericred-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Vericred\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Vericred-Api-Key', 'Bearer');

$api_instance = new Vericred\Client\Api\PlansApi();
$body = new \Swagger\Client\Model\RequestPlanFind(); // \Swagger\Client\Model\RequestPlanFind | 

try {
    $result = $api_instance->findPlans($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlansApi->findPlans: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\RequestPlanFind

Return type

\Swagger\Client\Model\PlanSearchResponse

Authorization

Vericred-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

showPlan

\Swagger\Client\Model\PlanShowResponse showPlan($id, $year)

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 above.)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Vericred-Api-Key
Vericred\Client\Configuration::getDefaultConfiguration()->setApiKey('Vericred-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Vericred\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Vericred-Api-Key', 'Bearer');

$api_instance = new Vericred\Client\Api\PlansApi();
$id = "88582NY0230001"; // string | ID of the Plan
$year = 2018; // int | Plan year (defaults to current year)

try {
    $result = $api_instance->showPlan($id, $year);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlansApi->showPlan: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string ID of the Plan
year int Plan year (defaults to current year) [optional]

Return type

\Swagger\Client\Model\PlanShowResponse

Authorization

Vericred-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]