CHcheckhq

Get a benefit

Changed on

Returns the specified benefit.

get/benefits/{benefit}

Request

Path parameters

benefitstring required

ID of the benefit to return.

Response

200

idstring
employeestring
benefitstring
company_benefitunknown
sourceunknown
periodunknown
descriptionstring
effective_startstring
effective_endunknown
company_contribution_amountunknown
company_contribution_percentinteger
company_period_amountunknown
employee_contribution_amountunknown
employee_contribution_percentinteger
employee_period_amountunknown
hsa_contribution_limitunknown
metadataobject

Example response

{
  "id": "ben_lrcYUhTk1FVZl2vSCOBP",
  "employee": "emp_kKTK4VafMNc5pIbI0G9x",
  "benefit": "401k",
  "description": "Guideline 401(k)",
  "effective_start": "2020-01-01",
  "company_contribution_percent": 1,
  "employee_contribution_percent": 1
}

Changes