Retrieve a plan | Kota Developer Products Documentation

curl https://test.api.kota.io/plans/pl_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "type": "health_insurance",
  "name": "Global Health Plus Plan",
  "description": "Comprehensive international health insurance plan covering medical, dental, and vision care worldwide.",
  "country": "us",
  "provider": {
    "id": "pr_7f8e9d6c5b4a3f2e1d0c9b8a7e6f5d4c",
    "name": "Kota Health Insurance",
    "description": "Leading provider of international health insurance solutions with a focus on global coverage and customer service.",
    "logo_url": "https://cdn.kota.io/logos/kota_health_insurance.png"
  },
  "documents": [
    {
      "title": "Insurance Product Information Document",
      "link": "https://cdn.kota.io/docs/global_health_plus_ipid.pdf",
      "type": "ipid"
    }
  ],
  "employer_eligibility_criteria": [
    {
      "type": "employees_count",
      "description": "Employers must have between 10 and 500 employees to be eligible.",
      "employees_count": {
        "min": 10,
        "max": 500
      }
    }
  ],
  "employee_eligibility_criteria": [
    {
      "type": "age_range",
      "description": "Eligible employees must be between 18 and 65 years old.",
      "age_range": {
        "min": 18,
        "max": 65
      }
    }
  ],
  "disclosures": [
    {
      "category": "regulatory",
      "type": "intermediary_role",
      "text": "This plan is offered through authorized intermediaries who act on behalf of the insurer."
    }
  ],
  "available_from": "2024-01-01",
  "object": "plan"
}

Retrieves a plan object by its ID.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

plan_idstringRequiredformat: "pl_.+"

Response

idstringformat: "pl_.+"

Unique identifier for the plan. Prefixed with pl_.

typeenum

The benefit type of the plan.

Allowed values:

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.

Errors

404

Not Found Error