Skip to main content
GET
/
view-specific
/
{policyId}
/
available-pricing
Get available pricing tiers for policy
curl --request GET \
  --url https://api.example.com/view-specific/{policyId}/available-pricing
{
  "tiers": [
    {
      "tierId": "<string>",
      "pricing": {
        "policy": {
          "id": "<string>",
          "entityId": "<string>",
          "provider": {
            "id": "<string>",
            "version": "<string>"
          },
          "rates": [
            {
              "id": "<string>",
              "rate": 123,
              "inputs": [
                {
                  "id": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "totalPremium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "components": [
            {
              "id": "<string>",
              "type": "PREMIUM",
              "premium": {
                "amountPreFeesAndTaxes": 123,
                "fees": [
                  {
                    "id": "<string>",
                    "chargeType": "ONE_TIME",
                    "amount": 123,
                    "brokerageFirmId": "<string>"
                  }
                ],
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "taxes": [
                  {
                    "id": "<string>",
                    "chargeType": "ONE_TIME",
                    "amount": 123
                  }
                ],
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              },
              "chargeType": "ONE_TIME"
            }
          ],
          "basePrice": 123
        },
        "assets": [
          {
            "id": "<string>",
            "entityId": "<string>",
            "provider": {
              "id": "<string>",
              "version": "<string>"
            },
            "rates": [
              {
                "id": "<string>",
                "rate": 123,
                "inputs": [
                  {
                    "id": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            ],
            "totalPremium": {
              "amountPreFeesAndTaxes": 123,
              "fees": [
                {
                  "id": "<string>",
                  "chargeType": "ONE_TIME",
                  "amount": 123,
                  "brokerageFirmId": "<string>"
                }
              ],
              "totalFees": 123,
              "amountWithFeesPreTaxes": 123,
              "taxes": [
                {
                  "id": "<string>",
                  "chargeType": "ONE_TIME",
                  "amount": 123
                }
              ],
              "totalTaxes": 123,
              "amountWithFeesAndTaxes": 123
            },
            "components": [
              {
                "id": "<string>",
                "type": "PREMIUM",
                "premium": {
                  "amountPreFeesAndTaxes": 123,
                  "fees": [
                    {
                      "id": "<string>",
                      "chargeType": "ONE_TIME",
                      "amount": 123,
                      "brokerageFirmId": "<string>"
                    }
                  ],
                  "totalFees": 123,
                  "amountWithFeesPreTaxes": 123,
                  "taxes": [
                    {
                      "id": "<string>",
                      "chargeType": "ONE_TIME",
                      "amount": 123
                    }
                  ],
                  "totalTaxes": 123,
                  "amountWithFeesAndTaxes": 123
                },
                "chargeType": "ONE_TIME"
              }
            ],
            "options": {
              "tier": "<string>",
              "excess": "<string>",
              "assetId": "<string>",
              "perils": [
                {
                  "id": "<string>",
                  "option": "<string>",
                  "available": true,
                  "unavailabilityMessage": "<string>"
                }
              ],
              "brokerageFees": [
                {
                  "brokerageFirmId": "<string>",
                  "fee": 50
                }
              ]
            },
            "basePrice": 123
          }
        ]
      },
      "perils": [
        {
          "id": "<string>",
          "included": true,
          "options": [
            "<string>"
          ],
          "customFields": [
            "<string>"
          ],
          "defaultCustomFieldValues": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "breakdown": {
        "frequency": "YEARLY",
        "total": {
          "premiumPreFeesAndTaxes": 123,
          "fees": 123,
          "withFeesPreTaxes": 123,
          "taxes": 123,
          "withFeesAndTaxes": 123
        },
        "recurring": {
          "premiumPreFeesAndTaxes": 123,
          "fees": 123,
          "withFeesPreTaxes": 123,
          "taxes": 123,
          "withFeesAndTaxes": 123
        },
        "oneTime": {
          "premiumPreFeesAndTaxes": 123,
          "fees": 123,
          "withFeesPreTaxes": 123,
          "taxes": 123,
          "withFeesAndTaxes": 123
        },
        "lines": [
          {
            "key": "<string>",
            "amount": 123,
            "forTypes": [
              "<string>"
            ],
            "adjustedAmount": 123,
            "type": "price",
            "subLines": [
              {
                "key": "<string>",
                "amount": 123,
                "forTypes": [
                  "<string>"
                ],
                "adjustedAmount": 123,
                "type": "price"
              }
            ]
          }
        ],
        "totalLine": {
          "key": "<string>",
          "amount": 123,
          "adjustedAmount": 123
        },
        "firstInvoiceTotal": {
          "key": "<string>",
          "amount": 123,
          "adjustedAmount": 123
        },
        "renewalTotal": {
          "key": "<string>",
          "amount": 123,
          "adjustedAmount": 123
        }
      },
      "outputCustomFields": {
        "policyCustomFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "assetCustomFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "customerCustomFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    }
  ],
  "defaultTier": "<string>",
  "selectedTier": "<string>",
  "legacyMode": true
}

Path Parameters

policyId
string
required

Policy ID

Query Parameters

branchId
string

Branch ID (optional, defaults to latest)

policyCustomFields
string

Policy custom fields as JSON string (e.g. [{"key":"breed","value":"Arabian"}])

assetCustomFields
string

Asset custom fields as JSON string (e.g. [{"key":"equineValue","value":5000}])

policyCustomFieldsInputs
string

Peril parameters as JSON string (e.g. {"peril-ASSISTANCE":true,"peril-GLASS_BREAKAGE":false})

Response

tiers
object[]
required

Available pricing tiers

defaultTier
string
required

Default tier ID

selectedTier
string

Previously saved tier selection on the policy

legacyMode
boolean

Legacy mode indicator (true if product not migrated)