Get Plan Benefits

GET 
/v1/plans/:planId/benefits

Retrieve the list of benefits attached to a given plan. Supports filtering and pagination.

Request

Path Parameters

planId integerrequired

The unique ID of the HMO plan.

Query Parameters

page integer

Page number for pagination.

per_page integer

Number of items per page.

search string

Keyword for searching by benefit/care name/type/group.

Responses

200

List of plan benefits

application/json

Schema

Schema

data object[]
Array [
id integer
hmo_plan_id integer
care_id integernullable
care_group_id integernullable
care_type_id integernullable
claim_category stringnullable
for_diagnoses boolean
name stringnullable
created_at date-timenullable
updated_at date-timenullable
deleted_at date-timenullable
limit_type string
limit_value number
waiting_period integernullable
meta objectnullable
enrollee_type stringnullable
gender stringnullable
allowed_care_type_ids integer[]nullable
covered boolean
benefit_wallets_count integer
care object nullable
oneOf
MOD1
id integer
name string
care_group objectnullable
care_type objectnullable
plan object
id integer
name string
cover_dependants integer
]

Example (from schema)

{
  "data": [
    {
      "id": 37,
      "hmo_plan_id": 1,
      "care_id": 97,
      "care_group_id": null,
      "care_type_id": null,
      "claim_category": null,
      "for_diagnoses": false,
      "name": null,
      "created_at": null,
      "updated_at": "2022-01-21T12:06:55.000000Z",
      "deleted_at": null,
      "limit_type": "max cost per claim",
      "limit_value": 10,
      "waiting_period": null,
      "meta": null,
      "enrollee_type": null,
      "gender": null,
      "allowed_care_type_ids": null,
      "covered": true,
      "benefit_wallets_count": 0,
      "care": {},
      "care_group": null,
      "care_type": null,
      "plan": {
        "id": 1,
        "name": "Gold",
        "cover_dependants": 0
      }
    }
  ]
}

401

Unauthenticated

404

Plan not found

Loading...