---
title: "Retrieve the scenarios for a product"
url: "https://developers.zinnia.com/apis/rate-configuration/versions/09cd2eb7-6cba-4d5f-b142-73e01c2ad670/operations/get-scenarios-for-product"
---

> Full API specification: https://developers.zinnia.com/apis/rate-configuration/versions/09cd2eb7-6cba-4d5f-b142-73e01c2ad670.md

# Retrieve the scenarios for a product

`GET` `/rate-configuration/v1/scenariosForProduct/carriers/{carrierId}/products/{productId}`

Operation ID: `get-scenarios-for-product`

Mirrors RateReadApi::scenariosForProduct — returns the scenarios to run for the product's calculation/illustration type

## Path parameters

- `carrierId` (string, required) - The Carrier ID
- `productId` (string, required) - The Product ID

## Query parameters

- `calculationType` (string, optional) - The calculation type identifier
- `illustrationType` (string, optional) - The illustration type identifier
- `jurisdiction` (string, optional) - Optional Jurisdiction to be provided in ISO format
- `fixedCostPeriod` (integer, int32, optional) - Optional fixed cost period
- `productVersion` (string, optional) - Optional product version
- `issueDate` (string, date, optional) - Optional issue date

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - The caller's authentication token was missing or invalid.
- `403` - Forbidden
- `404` - Not Found
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Rate Configuration
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io
    description: Development
paths:
  /rate-configuration/v1/scenariosForProduct/carriers/{carrierId}/products/{productId}:
    get:
      tags:
        - RateRead
      operationId: get-scenarios-for-product
      summary: Retrieve the scenarios for a product
      description: Mirrors RateReadApi::scenariosForProduct — returns the scenarios to
        run for the product's calculation/illustration type
      parameters:
        - name: carrierId
          in: path
          description: The Carrier ID
          required: true
          schema:
            type: string
          example: FNWL
        - name: productId
          in: path
          description: The Product ID
          required: true
          schema:
            type: string
          example: IU0101
        - name: calculationType
          in: query
          description: The calculation type identifier
          schema:
            type: string
          example: SINGLE_ILLUSTRATION
        - name: illustrationType
          in: query
          description: The illustration type identifier
          schema:
            type: string
          example: NEW_BUSINESS
        - name: jurisdiction
          in: query
          description: Optional Jurisdiction to be provided in ISO format
          schema:
            type: string
          example: US-PA
        - name: fixedCostPeriod
          in: query
          description: Optional fixed cost period
          schema:
            type: integer
            format: int32
            default: 0
          example: 10
        - name: productVersion
          in: query
          description: Optional product version
          schema:
            type: string
          example: 25.05.01.0
        - name: issueDate
          in: query
          description: Optional issue date
          schema:
            type: string
            format: date
          example: 2026-03-20
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ScenariosToRunItem"
        "400":
          description: Bad Request
        "401":
          description: The caller's authentication token was missing or invalid.
        "403":
          description: Forbidden
        "404":
          description: Not Found
        "500":
          description: Internal Server Error
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    ScenariosToRunItem:
      required:
        - duration
        - scenarioList
      type: object
      properties:
        scenarioList:
          type: array
          items:
            $ref: "#/components/schemas/ScenarioItem"
        duration:
          type: integer
          format: int32
      additionalProperties: false
      description: The scenarios to run for a product's calculation/illustration type,
        and the illustration duration.
    ScenarioItem:
      required:
        - id
        - isBasis
      type: object
      properties:
        id:
          type: string
        isBasis:
          type: boolean
      additionalProperties: false
      description: One scenario to run, mirroring a ScenarioObject entry from
        ScenarioMapping.json.
  securitySchemes:
    Auth0:
      type: openIdConnect
      description: OpenId Connect authentication
      openIdConnectUrl: https://login.dev.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://dev.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://dev.api.zinnia.io
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - https
```