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

# List your organization's rating plan requests for a product

> Your organization's current rating plan request for each state of the product, sorted by state. States never requested are absent. When an unavailable state is requested again, the new request replaces it here. Use requestProductRatingPlans to request more states.



## OpenAPI

````yaml /openapi.json get /insurance/products/{productId}/rating-plan-requests
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/products/{productId}/rating-plan-requests:
    get:
      tags:
        - Products
      summary: List your organization's rating plan requests for a product
      description: >-
        Your organization's current rating plan request for each state of the
        product, sorted by state. States never requested are absent. When an
        unavailable state is requested again, the new request replaces it here.
        Use requestProductRatingPlans to request more states.
      operationId: listProductRatingPlanRequests
      parameters:
        - schema:
            type: string
            description: >-
              Managed product_ ID or bare checked code; case-insensitive with
              Crockford aliases.
          required: true
          description: >-
            Managed product_ ID or bare checked code; case-insensitive with
            Crockford aliases.
          name: productId
          in: path
      responses:
        '200':
          description: Current request per state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RatingPlanRequests'
        '400':
          description: >-
            invalid_id for malformed, wrong-type or bad-checksum IDs; otherwise
            invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Missing or invalid credentials, or credential scope denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: The credential does not permit this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Product not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rate limited. Honor Retry-After (seconds) when provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Honor Retry-After (seconds).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingPlanRequests:
      type: object
      properties:
        productId:
          type: string
          description: Canonical `product_` ID.
        requests:
          type: array
          items:
            $ref: '#/components/schemas/V2RatingPlanRequest'
      required:
        - productId
        - requests
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
          required:
            - code
    V2RatingPlanRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
        productId:
          type: string
          description: Canonical `product_` ID.
        state:
          type: string
          description: The configured availability state, as listed on the product.
        status:
          type: string
          enum:
            - requested
            - available
            - unavailable
          description: >-
            `requested` until Effective staff resolve it; `available` when a
            rating plan exists for the state; `unavailable` when one cannot be
            provided (see `resolutionNote`).
        note:
          type: string
          nullable: true
          description: The requester's note, if any.
        resolutionNote:
          type: string
          nullable: true
          description: >-
            Why the plan is unavailable, or what an available plan covers. Null
            while open.
        raterId:
          type: string
          nullable: true
          description: The rater that serves an available plan, when one is named.
        createdAt:
          type: string
          format: date-time
        resolvedAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - productId
        - state
        - status
        - note
        - resolutionNote
        - raterId
        - createdAt
        - resolvedAt
      additionalProperties: false
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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