> ## Documentation Index > Fetch the complete documentation index at: https://docs.korint.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the pricing tiers available for a policy ## OpenAPI ````yaml /openapi.json get /policies/{policyId}/available-pricing openapi: 3.0.0 info: title: Korint API description: >- Quoting, policy issuance, billing, claims, documents and compliance for insurance distribution. version: 1.0.0 contact: {} servers: - url: https://api.korint.io description: Production - url: https://api.sandbox.korint.io description: Sandbox security: - oauth2: [] - bearerAuth: [] tags: [] paths: /policies/{policyId}/available-pricing: get: tags: - pricing summary: Get the pricing tiers available for a policy operationId: PricingReadsController_getAvailablePricing parameters: - name: tenant in: header required: true description: Your tenant identifier. Requests without it are rejected. schema: type: string - name: policyId required: true in: path description: Policy ID schema: pattern: >- ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$ type: string - name: branchId required: false in: query description: Branch ID (optional, defaults to latest) schema: pattern: >- ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$ type: string - name: policyCustomFields required: false in: query description: >- Policy custom fields as JSON string (e.g. [{"key":"breed","value":"Arabian"}]) schema: type: string - name: assetCustomFields required: false in: query description: >- Asset custom fields as JSON string (e.g. [{"key":"equineValue","value":5000}]) schema: type: string - name: policyCustomFieldsInputs required: false in: query description: >- Peril parameters as JSON string (e.g. {"peril-ASSISTANCE":true,"peril-GLASS_BREAKAGE":false}) schema: type: string - name: manualComponentValues required: false in: query description: >- Manual component values as a JSON-encoded string, e.g. {"values":{"RETAIL_SUBSCRIPTION_FEE":5000}}. schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAvailablePricingOutput' '400': content: application/json: schema: anyOf: - $ref: '#/components/schemas/InvalidPricingDetailsErrorDto' examples: INVALID_PRICING_DETAILS: value: code: INVALID_PRICING_DETAILS message: Pricing details failed validation details: {} description: '' '404': content: application/json: schema: anyOf: - $ref: '#/components/schemas/PolicyNotFoundErrorDto' examples: POLICY_NOT_FOUND: value: code: POLICY_NOT_FOUND message: Policy {policyId} ({branchId}) not found details: {} description: '' components: schemas: GetAvailablePricingOutput: type: object properties: tiers: description: Available pricing tiers type: array items: $ref: '#/components/schemas/AvailablePricingTierDto' defaultTier: type: string description: Default tier ID selectedTier: type: string description: >- The tier the user actually saved; undefined when no selection has been made legacyMode: type: boolean description: Legacy mode indicator (true if product not migrated) required: - tiers - defaultTier InvalidPricingDetailsErrorDto: type: object properties: code: type: string enum: - INVALID_PRICING_DETAILS message: type: string example: Pricing details failed validation details: $ref: '#/components/schemas/InvalidPricingDetailsDetailsDto' required: - code - message - details PolicyNotFoundErrorDto: type: object properties: code: type: string enum: - POLICY_NOT_FOUND message: type: string example: Policy {policyId} ({branchId}) not found details: $ref: '#/components/schemas/PolicyNotFoundDetailsDto' required: - code - message - details AvailablePricingTierDto: type: object properties: tierId: type: string description: >- Tier ID, as returned in `GET /policies/{policyId}/available-pricing`. Tiers are computed per policy, so there is no fixed list. pricing: description: Pricing for this tier allOf: - $ref: '#/components/schemas/PolicyAndAssetsQuoteDto' breakdown: description: Flat price breakdown for this tier allOf: - $ref: '#/components/schemas/PriceBreakdownOutputDto' perils: description: Perils for this tier type: array items: $ref: '#/components/schemas/AvailablePricingPerilDto' outputCustomFields: description: Custom fields computed from pricing engine outputs allOf: - $ref: '#/components/schemas/OutputCustomFieldsDto' required: - tierId - pricing - perils InvalidPricingDetailsDetailsDto: type: object properties: product: type: string businessEntity: allOf: - $ref: '#/components/schemas/BusinessEntity' errors: type: array items: $ref: '#/components/schemas/InvalidPricingDetailsErrorsDto' required: - product - businessEntity - errors PolicyNotFoundDetailsDto: type: object properties: policyId: type: string branchId: type: string whenAt: type: string simulatedAt: type: string required: - policyId PolicyAndAssetsQuoteDto: type: object properties: policy: $ref: '#/components/schemas/PolicyQuoteDto' assets: type: array items: $ref: '#/components/schemas/AssetQuoteDto' required: - policy - assets PriceBreakdownOutputDto: type: object properties: frequency: type: string description: Billing frequency from policy config enum: - YEARLY - HALF_YEARLY - QUARTERLY - MONTHLY - BIENNIAL - WEEKLY total: description: Full contract amounts (face value) allOf: - $ref: '#/components/schemas/BreakdownAmounts' recurring: description: Recurring amounts divided by frequency allOf: - $ref: '#/components/schemas/BreakdownAmounts' oneTime: description: One-time amounts at face value allOf: - $ref: '#/components/schemas/BreakdownAmounts' lines: description: >- Configurable display lines computed from product priceBreakdownConfig type: array items: $ref: '#/components/schemas/PriceBreakdownLineOutputDto' totalLine: description: Configurable total display line allOf: - $ref: '#/components/schemas/PriceBreakdownTotalOutputDto' firstInvoiceTotal: description: First invoice total display line allOf: - $ref: '#/components/schemas/PriceBreakdownTotalOutputDto' renewalTotal: description: Renewal total display line allOf: - $ref: '#/components/schemas/PriceBreakdownTotalOutputDto' required: - frequency - total - recurring - oneTime AvailablePricingPerilDto: type: object properties: id: type: string description: Peril ID included: type: boolean description: Whether peril is included in this tier pricing options: description: Available option values for this peril type: array items: type: string customFields: description: Custom field names for this peril type: array items: type: string defaultCustomFieldValues: description: Default custom field values type: array items: $ref: '#/components/schemas/CustomFieldDto' required: - id - included OutputCustomFieldsDto: type: object properties: policyCustomFields: description: Policy custom fields computed from pricing type: array items: $ref: '#/components/schemas/CustomFieldDto' assetCustomFields: description: Asset custom fields computed from pricing type: array items: $ref: '#/components/schemas/CustomFieldDto' customerCustomFields: description: Customer custom fields computed from pricing type: array items: $ref: '#/components/schemas/CustomFieldDto' required: - policyCustomFields - assetCustomFields - customerCustomFields BusinessEntity: type: string enum: - PAYMENT_METHOD - PAYMENT - POLICY - CUSTOMER - ASSET - INVOICE - DOCUMENT - SIGNATURE - TENANT - PRODUCT - QUOTE - BROKERAGE_FIRM - CLAIM - CLAIM_MANAGEMENT - CLAIMANT - EXTERNAL_SERVICE - NOTIFICATION - PREMIUM_SCHEDULE - CHECK - ALERT - DISTRIBUTION_REQUEST - DEROGATION - BROKERAGE_FEE - COMMENT - CONVERSATION - CONVERSATION_MESSAGE InvalidPricingDetailsErrorsDto: type: object properties: key: type: string errorDetails: type: array items: type: string value: type: object required: - key - errorDetails PolicyQuoteDto: type: object properties: id: type: string description: Quote id entityId: type: string description: Entity the quote is for provider: $ref: '#/components/schemas/QuoteProviderDto' basePrice: type: integer rates: type: array items: $ref: '#/components/schemas/RateDto' totalPremium: $ref: '#/components/schemas/AmountDto' components: description: components of the quote type: array items: $ref: '#/components/schemas/QuoteComponentDto' required: - id - entityId - provider - rates - totalPremium - components AssetQuoteDto: type: object properties: id: type: string description: Quote id entityId: type: string description: Entity the quote is for provider: $ref: '#/components/schemas/QuoteProviderDto' basePrice: type: integer rates: type: array items: $ref: '#/components/schemas/RateDto' totalPremium: $ref: '#/components/schemas/AmountDto' components: description: components of the quote type: array items: $ref: '#/components/schemas/QuoteComponentDto' options: description: Quote options chosen by client allOf: - $ref: '#/components/schemas/AssetQuoteOptionsDto' priceBand: type: string description: >- Price band resolved by the pricing engine, when the product exposes one (e.g. STANDARD/STANDARD_2/LUXE_1/LUXE_2 for Garantie Plus) required: - id - entityId - provider - rates - totalPremium - components - options BreakdownAmounts: type: object properties: premiumPreFeesAndTaxes: type: integer description: Premium before fees and taxes fees: type: integer description: Fees withFeesPreTaxes: type: integer description: Premium + fees before taxes taxes: type: integer description: Taxes withFeesAndTaxes: type: integer description: Premium + fees + taxes required: - premiumPreFeesAndTaxes - fees - withFeesPreTaxes - taxes - withFeesAndTaxes PriceBreakdownLineOutputDto: type: object properties: key: type: string description: Line key identifier amount: type: integer description: Computed amount in euro cents (face/annual value) adjustedAmount: type: integer description: >- Frequency-adjusted amount in euro cents (pro-rated per billing period) forTypes: description: Business role types this line is visible to type: array items: type: string type: type: string description: Display type enum: - price - percentage subLines: description: Nested sub-lines type: array items: $ref: '#/components/schemas/DisplayLineSubLineOutputDto' required: - key - amount - adjustedAmount - forTypes PriceBreakdownTotalOutputDto: type: object properties: key: type: string description: Total line key identifier amount: type: integer description: Computed total amount in euro cents (face/annual value) adjustedAmount: type: integer description: >- Frequency-adjusted total amount in euro cents (pro-rated per billing period) required: - key - amount - adjustedAmount CustomFieldDto: type: object properties: key: type: string value: oneOf: - type: string - type: number - type: boolean required: - key - value QuoteProviderDto: type: object properties: id: type: string version: type: string required: - id - version RateDto: type: object properties: id: type: string rate: type: integer inputs: type: array items: $ref: '#/components/schemas/RateInputDto' required: - id - rate - inputs AmountDto: type: object properties: amountPreFeesAndTaxes: type: integer fees: type: array items: $ref: '#/components/schemas/FeeDto' totalFees: type: integer amountWithFeesPreTaxes: type: integer taxes: type: array items: $ref: '#/components/schemas/TaxDto' totalTaxes: type: integer amountWithFeesAndTaxes: type: integer required: - amountPreFeesAndTaxes - fees - totalFees - amountWithFeesPreTaxes - taxes - totalTaxes - amountWithFeesAndTaxes QuoteComponentDto: type: object properties: id: type: string type: type: string enum: - PREMIUM - PERIL - FEE - TAX - SPECIAL premium: $ref: '#/components/schemas/AmountDto' chargeType: type: string description: Charge type of component enum: - ONE_TIME - SPOT - RECURRING required: - id - type - premium - chargeType AssetQuoteOptionsDto: type: object properties: tier: type: string excess: type: string perils: type: array items: $ref: '#/components/schemas/ConfigQuoteChosenWarrantyDto' assetId: type: string brokerageFees: type: array items: $ref: '#/components/schemas/BrokerageFeeOnPolicy' required: - tier - excess - assetId DisplayLineSubLineOutputDto: type: object properties: key: type: string description: Line key identifier amount: type: integer description: Computed amount in euro cents (face/annual value) adjustedAmount: type: integer description: >- Frequency-adjusted amount in euro cents (pro-rated per billing period) forTypes: description: Business role types this line is visible to type: array items: type: string type: type: string description: Display type enum: - price - percentage required: - key - amount - adjustedAmount - forTypes RateInputDto: type: object properties: id: type: string description: id value: description: value oneOf: - type: string - type: number required: - id - value FeeDto: type: object properties: id: type: string brokerageFirmId: type: string chargeType: type: string enum: - ONE_TIME - SPOT - RECURRING amount: type: integer required: - id - chargeType - amount TaxDto: type: object properties: id: type: string chargeType: type: string enum: - ONE_TIME - SPOT - RECURRING amount: type: integer required: - id - chargeType - amount ConfigQuoteChosenWarrantyDto: type: object properties: id: type: string option: type: string available: type: boolean unavailabilityMessage: type: string required: - id BrokerageFeeOnPolicy: type: object properties: brokerageFirmId: pattern: >- ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$ type: string description: Brokerage firm id maximum: 100 minimum: 0 fee: type: number description: Fee maximum: 100 minimum: 0 required: - brokerageFirmId - fee securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://korint-tenant.auth.eu-west-3.amazoncognito.com/oauth2/token scopes: korint.io/account: Read account information korint.io/analytics: Access analytics endpoints korint.io/assets: Access asset endpoints korint.io/billing: Access billing endpoints korint.io/branches: Access branch endpoints korint.io/broker: Access broker endpoints korint.io/claims: Access claim endpoints korint.io/comments: Access comment endpoints korint.io/customers: Access customer endpoints korint.io/derogations: Access derogation endpoints korint.io/documents: Access document endpoints korint.io/external: Access external lookup endpoints korint.io/external-claims: Declare claims from an external system korint.io/internal-notes: Access internal note endpoints korint.io/invitations: Access invitation endpoints korint.io/payments: Access payment endpoints korint.io/permissions: Access permission management endpoints korint.io/policies: Access policy endpoints korint.io/quotes: Access quote endpoints korint.io/reportings: Access reporting endpoints korint.io/signature: Access signature endpoints description: >- Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace `tenant` with your tenant identifier. bearerAuth: scheme: bearer bearerFormat: JWT type: http description: An access token obtained from your tenant authorization server. ````