Sign in
latestOpenAPI 3.1.12026-08-1585397785.9 KB

85bb8b3c42b4

Plans

Retrieve a plan

Retrieves a plan object by its ID.

get/plans/{plan_id}

Path parameters

plan_idstring required
Example:pl_3b1333d87d9d4fd6ad83ba7f6b0e951a

Query parameters

group_idstring

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

Example:gr_3b1333d87d9d4fd6ad83ba7f6b0e951a

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

start_datestring date

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

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

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK

objectstring

Object type. Always plan.

idstring required

Unique identifier for the plan. Prefixed with pl_.

type'health_insurance' required
namestring required

The name of the plan.

descriptionstring required

Description of the plan.

country'af' | 'ax' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'aq' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bt' | 'bo' | 'bq' | 'ba' | 'bw' | 'bv' | 'br' | 'io' | 'bn' | 'bg' | 'bf' | 'bi' | 'cv' | 'kh' | 'cm' | 'ca' | 'ky' | 'cf' | 'td' | 'cl' | 'cn' | 'cx' | 'cc' | 'co' | 'km' | 'cg' | 'cd' | 'ck' | 'cr' | 'ci' | 'hr' | 'cu' | 'cw' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'gq' | 'er' | 'ee' | 'sz' | 'et' | 'fk' | 'fo' | 'fj' | 'fi' | 'fr' | 'gf' | 'pf' | 'tf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gd' | 'gp' | 'gu' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hm' | 'va' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'im' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kp' | 'kr' | 'xk' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mh' | 'mq' | 'mr' | 'mu' | 'yt' | 'mx' | 'fm' | 'md' | 'mc' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'nc' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'mk' | 'mp' | 'no' | 'om' | 'pk' | 'pw' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pn' | 'pl' | 'pt' | 'pr' | 'qa' | 're' | 'ro' | 'ru' | 'rw' | 'bl' | 'sh' | 'kn' | 'lc' | 'mf' | 'pm' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sx' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'gs' | 'ss' | 'es' | 'lk' | 'sd' | 'sr' | 'sj' | 'se' | 'ch' | 'sy' | 'tw' | 'tj' | 'tz' | 'th' | 'tl' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'ae' | 'gb' | 'um' | 'us' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'wf' | 'eh' | 'ye' | 'zm' | 'zw' required
available_fromstring date required

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

available_tostring date nullable

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

eligible_countinteger nullable

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 nullable

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 nullable

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

Example response

{
  "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "provider": {
    "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "health_insurance": {
    "pricing": {
      "per_member": {
        "member_type_pricing": [
          {
            "monthly_premium": 123.45
          }
        ]
      },
      "tier_based": {
        "tiers": [
          {
            "monthly_premium": 123.45,
            "annual_premium": 123.45
          }
        ]
      }
    }
  },
  "available_from": "2024-12-01",
  "available_to": "2024-12-01",
  "coverage_options": [
    {
      "id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "required": true,
      "options": [
        {
          "id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
        }
      ]
    }
  ]
}