Retrieve a plan | Kota Developer Products Documentation

import requests
url = "https://test.api.kota.io/plans/pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
headers = {"Authorization": "Bearer <apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "type": "health_insurance",
  "name": "string",
  "description": "string",
  "country": "af",
  "provider": {
    "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "name": "string",
    "description": "string",
    "logo_url": "string"
  },
  "documents": [
    {
      "title": "string",
      "link": "string",
      "type": "ipid"
    }
  ],
  "employer_eligibility_criteria": [
    {
      "type": "employees_count",
      "description": "string",
      "employees_count": null,
      "members_count": null,
      "industry_exclusions": null
    }
  ],
  "employee_eligibility_criteria": [
    {
      "type": "age_range",
      "description": "string",
      "age_range": null
    }
  ],
  "available_from": "2024-12-01",
  "object": "string",
  "health_insurance": null,
  "available_to": "2024-12-01"
}

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.

available_fromdate

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

objectstring or nullRead-only

Object type. Always plan.

health_insuranceobject or null

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.

Authentication

Path parameters

Response

Errors