Retrieve a plan

GET

/plans/:plan_id

GET

/plans/:plan_id

$ curl https://test.api.kota.io/plans/pl_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "type": "health_insurance",
4   "name": "Global Health Plus Plan",
5   "description": "Comprehensive international health insurance plan covering medical, dental, and vision care worldwide.",
6   "country": "us",
7   "provider": {
8     "id": "pr_7f9a3c2d4e5b6a7c8d9e0f1a2b3c4d5e",
9     "name": "Global Health Insurance Co.",
10     "description": "Leading provider of international health insurance solutions.",
11     "logo_url": "https://globalhealthinsurance.com/assets/logo.png"
12   },
13   "documents": [
14     {
15       "title": "Insurance Product Information Document",
16       "link": "https://globalhealthinsurance.com/docs/ghp-ipid.pdf",
17       "type": "ipid"
18     }
19   ],
20   "employer_eligibility_criteria": [
21     {
22       "type": "employees_count",
23       "description": "Employer must have between 10 and 500 employees to qualify.",
24       "employees_count": {
25         "min": 10,
26         "max": 500
27       },
28       "members_count": null,
29       "industry_exclusions": null
30     }
31   ],
32   "employee_eligibility_criteria": [
33     {
34       "type": "age_range",
35       "description": "Eligible employees must be between 18 and 65 years old.",
36       "age_range": {
37         "min": 18,
38         "max": 65
39       }
40     }
41   ],
42   "disclosures": [
43     {
44       "category": "regulatory",
45       "type": "intermediary_role",
46       "text": "This plan is offered through authorized insurance intermediaries."
47     }
48   ],
49   "available_from": "2024-01-01",
50   "object": "plan",
51   "health_insurance": null,
52   "available_to": null,
53   "coverage_options": null,
54   "eligible_count": null,
55   "ineligible_count": null,
56   "total_count": null
57 }

Retrieves a plan object by its ID.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

plan_idstringRequiredformat: "pl_.+"

Query parameters

group_idstringOptionalformat: "gr_.+"

When provided together with start_date, per-plan eligibility counts are included in the response. Silently ignored if not paired with start_date.

start_datedateOptional

Reference date used to compute employee age when evaluating eligibility. Required together with group_id for counts to be included.

Response

idstringformat: "pl_.+"

Unique identifier for the plan. Prefixed with pl_.

typeenum

The benefit type of the plan.

namestring

The name of the plan.

descriptionstring

Description of the plan.

countryenum

The country this plan is available in.

providerobject

The provider offering this plan.

documentslist of objects

List of plan documents (e.g., IPIDs, T&Cs).

employer_eligibility_criterialist of objects

Eligibility criteria that employers must meet.

employee_eligibility_criterialist of objects

Eligibility criteria that employees must meet.

disclosureslist of objects

Disclosures associated with this plan.

available_fromdate

The date from which this plan is available (inclusive).

objectstringRead-only

Object type. Always plan.

health_insuranceobject

Health insurance-specific details. Only populated when type is health_insurance.

available_todate or null

The date until which this plan is available (inclusive). Null if the plan has no end date.

coverage_optionslist of objects or null

Coverage options available for this plan, organized by scope and input type.

eligible_countinteger or null

Number of employees in the queried group eligible for this plan as-of start_date. Only present when both group_id and start_date query parameters are provided.

ineligible_countinteger or null

Number of employees in the queried group ineligible for this plan as-of start_date. Only present when both group_id and start_date query parameters are provided.

total_countinteger or null

Total employees in the queried group. Only present when both group_id and start_date query parameters are provided.

Errors

404

Not Found Error