Pull Quote Results

Retrieve rates and calculation outputs for an ICHRA quote

circle-exclamation

The results of an ICHRA quote include the available plans and premiums for each member and the outputs of any additional calculations requested. The quote results are structured on a member by member basis and are identical across each of the following methodologies to pull results.

  • The "ICHRA Quote Rates" Endpoint - returns results for all quoted members in a paginated endpoint. Best used in workflows that require all member results and group sizes up to ~1,000 members.

  • The "ICHRA Quote Member Rates" Endpoint - returns results for a single member as specified by that member's id. Best used when results are required selectively for each member.

  • A JSONL Bulk Export File - returns results for all quoted members in a JSONL file that can be downloaded via a pre-signed URL. Best used in workflows that require all member results and group sizes are larger than ~1,000 members.

ICHRA Quote Results

ICHRA quote results are structured as member objects. Members can be identified through the id returned in the "Create Members" endpoint, referenced in the Add a Census section. For each member, quoted plans, their premiums, and optional calculation outputs are included.

  • Member ID member_id - the unique id for the member, as returned in the "Create Members" endpoint.

  • Error Messages error_messages - an array of string error messages resulting from attempts to quote the member. Errors for ICHRA quoting are rare and typically are results of missing required data - for example, income is not provided for the member but the ICHRA affordability calculation was requested. The quote metadata's job.error_count corresponds to the number of members with one or more error_messages.

  • Calculations calculations - the calculations object and the nested calculations are only included in the response if enabled in the Create ICHRA Quote request.

    • PTC Subsidy ptc_subsidy - the values included mirror those documented in the Subsidies and Tax Credits section for individual market quotes.

    • ICHRA Affordability ichra_affordability - the minimum_employer_contribution is based on the member's safe_harbor_income; the fpl_minimum_employer_contribution is based on the FPL for the member.

    • CSR Eligibility csr_eligibility - if csr_eligibility.eligible is true, indicates that the member is eligible for CSR plans. The member's rates array will include CSR plan variants, subject to availability and any optional filters applied.

  • Rates rates - a list of available plans and their premiums, specific to the member. If optional filters were applied to the quote, they will reduce the plans returned in this array. Each object in the rates array includes the following data.

    • Plan HIOS ID plan_id - the HIOS ID of the quoted plan. HIOS IDs are unique by market and plan year and can be used to link the quoted plan to cached plan benefits. More information on caching benefit data can be found in the Bulk Exports in the API section.

    • Premium premium - the total quoted premium for the member and their dependents.

    • Premiums by Applicant premiums_by_applicant - the applicant-level premium breakdowns for the member and each of their dependents. This key will only be included if premiums by applicant is enabled in the Create ICHRA Quote request. The data in the premiums_by_applicant array is consistent with the Premiums by Applicant feature being released in Q1 2026. For Group ICHRA Quote responses, this key will additionally include an id field, which ties back to the response to the Add a Census request - the members[].id and members[].dependents[].id will be referenced to associate each applicant for that member's household to an object in the premiums_by_applicant array.

Methodologies to Pull Quote Results

ICHRA Quote Rates

The "Display Group ICHRA Quote Rates" endpoint can be used to pull the quote results for all members in a paginated response. The endpoint path is GET /ichra_quotes/{ichra_quote_id}/rates. Additionally, a URI parameter is available to filter the endpoint response to only include members with a quoting error. This can be set by adding ?member_error=true to the endpoint path.

ICHRA Quote Member Rates

The "Display Member ICHRA Quote Rates" endpoint can be used to pull the the quote results for a single member, using the id returned in the "Create Members" endpoint. The endpoint path is GET /ichra_quotes/{ichra_quote_id}/rates/{member_id}. The response schema for this endpoint will be consistent with a single member's object, as shown in the ICHRA Quote Rates response above.

Bulk Export Files

If included in the request to create the ICHRA quote, a bulk export file will be generated with quote results for all members. This file is structured as JSONL, with each line representing one member as an object with their quoted plans and calculations.

Last updated

Was this helpful?