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

# List plans

> Static plan metadata: identifiers, plan classification, plan design amounts, brand assets, and required disclaimers. Combine with a group quote for group-specific pricing.



## OpenAPI

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


    Money is always integer cents. Dates are `YYYY-MM-DD`; timestamps are ISO
    8601 UTC. Quotes are indicative pending underwriting confirmation. A BAA and
    data processing agreement are executed before live mode is enabled.
  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: Deterministic, synchronous quotes. Indicative pending underwriting.
  - name: Enrollments
    description: Plan selection and employer provisioning.
  - name: Account
    description: Aggregate, de-identified employer account data.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /plans:
    get:
      tags:
        - Plans
      summary: List plans
      description: >-
        Static plan metadata: identifiers, plan classification, plan design
        amounts, brand assets, and required disclaimers. Combine with a group
        quote for group-specific pricing.
      operationId: listPlans
      responses:
        '200':
          description: Available plans.
          content:
            application/json:
              schema:
                type: object
                required:
                  - plans
                properties:
                  plans:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plan'
              example:
                plans:
                  - id: diamond
                    name: Prescience Diamond
                    carrierName: Prescience
                    planType: self_funded_level_funded
                    deductibleIndividualCents: 150000
                    deductibleFamilyCents: 300000
                    oopMaxIndividualCents: 705000
                    oopMaxFamilyCents: 1410000
                    hsaEligible: true
                    employeePremiumCents: 0
                    assets:
                      logoUrl: >-
                        https://www.getprescience.com/img/prescience-wordmark.svg
                      markUrl: https://www.getprescience.com/img/prescience-mark.svg
                    disclaimers:
                      - >-
                        Final plan documents govern. Benefit details are
                        confirmed during onboarding.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
          const: diamond
        name:
          type: string
          example: Prescience Diamond
        carrierName:
          type: string
          description: >-
            Display name for customer-facing plan listings. Use the approved
            plan display fields rather than expanding backend classification
            values into marketing copy.
        planType:
          type: string
          const: self_funded_level_funded
        deductibleIndividualCents:
          type: integer
          example: 150000
        deductibleFamilyCents:
          type: integer
          example: 300000
        oopMaxIndividualCents:
          type: integer
          example: 705000
        oopMaxFamilyCents:
          type: integer
          example: 1410000
        hsaEligible:
          type: boolean
        employeePremiumCents:
          type: integer
          const: 0
        assets:
          type: object
          properties:
            logoUrl:
              type: string
              format: uri
            markUrl:
              type: string
              format: uri
        disclaimers:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - unauthorized
            - live_mode_disabled
            - forbidden
            - not_found
            - invalid_request
            - conflict
            - quote_expired
            - census_required
            - rate_limited
            - server_error
            - not_configured
          description: Stable machine-readable error code.
        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
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: >-
              Provide a valid partner API key as `Authorization: Bearer
              psk_...`.
    RateLimited:
      description: Rate limit exceeded. Honor `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
            message: Rate limit exceeded. Retry after 12 seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
          example: 12
    ServerError:
      description: >-
        Something failed on our side. Safe to retry with the same
        `Idempotency-Key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: server_error
            message: Internal error. The request was not applied.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Partner API key. `psk_test_<32 hex>` for test mode, `psk_live_<32 hex>`
        for live mode. Keys are stored hashed and cannot be recovered; store
        them in your secrets manager on issue.

````