> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprescience.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a plan (brokers)

> The static details of one plan for a broker key: `diamond` or `value`. A quote has each group's numbers; this has what the plan is, and it is the same for every group, so cache it. Other partner types get `404`.



## OpenAPI

````yaml /api-reference/openapi.json get /plans/{planId}
openapi: 3.1.0
info:
  title: Prescience Partner API
  version: 1.1.0
  description: >-
    Create employer groups, submit census records, generate preliminary
    market-rate quotes, create iframe sessions, create enrollments, and read
    aggregate account data.


    Money is always integer cents. Dates are `YYYY-MM-DD`; timestamps are ISO
    8601 UTC. Final pricing, eligibility, network availability, and plan
    documents are confirmed during underwriting and onboarding. A BAA and data
    processing agreement are executed before live mode is enabled.


    Field names: broker keys send and receive snake_case (camelCase requests are
    still accepted). HR platform partners use camelCase. Where an operation
    serves both, the broker schema comes first and the camelCase one second.
  contact:
    name: Prescience partner engineering
    email: partners@getprescience.com
servers:
  - url: https://www.getprescience.com/api/partner/v1
    description: >-
      Production. Test and live traffic share this host; mode comes from your
      API key.
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Connectivity and key checks.
  - name: Plans
    description: Static plan metadata.
  - name: Groups
    description: 'Employer groups: the root resource of every integration.'
  - name: Census
    description: Pre-enrollment census intake and ongoing member sync.
  - name: Quotes
    description: >-
      Preliminary quotes built from the stored census and current local
      market-plan snapshot.
  - name: Enrollments
    description: Plan selection and employer provisioning.
  - name: Account
    description: Aggregate, de-identified employer account data.
  - name: Brokers
    description: >-
      Quoting for brokers, the MCP server, and elections for partner-run
      enrollment.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /plans/{planId}:
    get:
      tags:
        - Plans
      summary: Get a plan (brokers)
      description: >-
        The static details of one plan for a broker key: `diamond` or `value`. A
        quote has each group's numbers; this has what the plan is, and it is the
        same for every group, so cache it. Other partner types get `404`.
      operationId: getPlan
      parameters:
        - name: planId
          in: path
          required: true
          schema:
            type: string
            enum:
              - diamond
              - value
      responses:
        '200':
          description: The plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrokerPlanDetail'
              example:
                id: diamond
                name: Prescience Diamond
                description: >-
                  The richest coverage, with the lowest member out-of-pocket
                  costs.
                benefits:
                  member_coinsurance_pct: 0
                  hsa_eligible: true
                  features:
                    - title: Advanced blood testing
                      description: >-
                        Included through Prescience Foresight, with
                        clinician-guided follow-up.
                    - title: Genetic testing
                      description: >-
                        Included when clinically appropriate, with results
                        translated into a personal care plan.
                    - title: 24/7 care companion
                      description: >-
                        Crystal helps members find care, understand costs, and
                        get answers before a bill arrives.
                    - title: Preventive health programs
                      description: >-
                        Access to Prescience Foresight programs, including
                        metabolic health and connected-device support, subject
                        to eligibility.
                    - title: GLP-1s for all indications
                      description: Covered for every indication, not only diabetes.
                    - title: HSA-eligible
                      description: >-
                        Pairs with a health savings account for pre-tax saving
                        on care.
                    - title: Wearable included
                      description: Every member gets a wearable at no extra cost.
                    - title: Fully managed setup
                      description: >-
                        Prescience runs plan setup, enrollment and payroll
                        syncing.
                member_terms: >-
                  The lowest member out-of-pocket costs. Deductible and
                  out-of-pocket maximums are set per group: a quote has them as
                  deductible_cents and oop_max_cents.
                employer_contribution:
                  min_pct: 50
                  max_pct: 100
                logos:
                  plan: https://www.getprescience.com/img/prescience-mark.png
                  wordmark: https://www.getprescience.com/img/prescience-wordmark.svg
                selling_guide:
                  url: https://www.getprescience.com/api/partner/v1/mcp/skill
                  markdown_url: >-
                    https://www.getprescience.com/api/partner/v1/mcp/skill?format=md
                disclaimers:
                  - >-
                    Final plan documents govern. Benefit details are confirmed
                    during onboarding.
        '404':
          description: No such plan, or not a broker key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BrokerPlanDetail:
      type: object
      required:
        - id
        - name
        - description
        - benefits
        - member_terms
        - logos
      properties:
        id:
          type: string
          enum:
            - diamond
            - value
        name:
          type: string
        description:
          type: string
          description: One plain line on what the plan is.
        benefits:
          type: object
          properties:
            member_coinsurance_pct:
              type: number
            hsa_eligible:
              type: boolean
            features:
              type: array
              items:
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
        member_terms:
          type: string
          description: >-
            How the member cost-sharing reads. The amounts for a group are in
            its quote (`member_deductible`, `member_oop_max`).
        employer_contribution:
          type: object
          description: The share of premium an employer may pay.
          properties:
            min_pct:
              type: number
            max_pct:
              type: number
        logos:
          type: object
          properties:
            plan:
              type: string
              description: The Prescience mark.
            wordmark:
              type: string
              description: The Prescience wordmark.
        selling_guide:
          type: object
          description: 'The selling skill: a zip for Agent Skills, and the SKILL.md.'
          properties:
            url:
              type: string
            markdown_url:
              type: string
        disclaimers:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - live_mode_disabled
            - forbidden
            - not_found
            - conflict
            - rates_pending
            - quote_expired
            - market_unavailable
            - census_required
            - rate_limited
            - server_error
            - not_configured
            - email_not_allowed
            - verification_failed
          description: >-
            Stable machine-readable error code. `email_not_allowed` and
            `verification_failed` come only from the iframe's own endpoints,
            which partners do not call.
        message:
          type: string
          description: >-
            Human-readable explanation. Wording may change; branch on `error`,
            not `message`.
        details:
          type: array
          description: Present on `invalid_request`. One entry per failed field.
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
                example: zip
              message:
                type: string
                example: zip must be a 5-digit ZIP code
              index:
                type: integer
                description: >-
                  For array payloads (census rows), the zero-based index of the
                  failing row.
                example: 7
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Partner API key. `psk_test_<32 hex>` for test mode, `psk_live_<32 hex>`
        for live mode. Store them in your secrets manager on issue. Live keys
        are shown once; the scoped partner portal can show an active sandbox key
        again.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.