---
title: "GET /billing/{tenantLocator}/installments/quotes/statelessPreview"
method: GET
path: "/billing/{tenantLocator}/installments/quotes/statelessPreview"
---

# GET /billing/{tenantLocator}/installments/quotes/statelessPreview

`GET /billing/{tenantLocator}/installments/quotes/statelessPreview`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/installments/quotes/statelessPreview`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/installments/quotes/statelessPreview/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `quotePreviewRequest` QuoteBillingPreviewRequest, required
  - `accountLocator` string, ulid, required
  - `productName` string, required
  - `termStartTime` string, date-time, required
  - `termEndTime` string, date-time, required
  - `timezone` string
  - `durationBasis` 'years' | 'months' | 'weeks' | 'days' | 'hours'
  - `currency` string
  - `invoiceFeeAmount` number
  - `installmentPreferences` InstallmentPreferences
    - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays'
    - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay'
    - `generateLeadDays` integer
    - `dueLeadDays` integer
    - `installmentWeights` number[], required
    - `maxInstallmentsPerTerm` integer
    - `installmentPlanName` string
    - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
    - `dayOfMonth` integer
    - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
    - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
    - `anchorTime` string, date-time
    - `autopayLeadDays` number
  - `charges` PreviewChargeRequest[], required
    - `amount` number, required
    - `chargeType` string, required
    - `elementLocator` string, ulid
    - `elementStaticLocator` string, ulid

## Response `200`

OK

- InstallmentsPreview
  - `installments` Installment[], required
    - `locator` string, ulid, required
    - `installmentLatticeLocator` string, ulid, required
    - `accountLocator` string, ulid, required
    - `currency` string, required
    - `timezone` string, required
    - `installmentFrameIndex` integer, required
    - `quoteLocator` string, ulid
    - `policyLocator` string, ulid
    - `transactionLocator` string, ulid
    - `installmentStartTime` string, date-time, required
    - `installmentEndTime` string, date-time, required
    - `coverageStartTime` string, date-time, required
    - `coverageEndTime` string, date-time, required
    - `installmentDuration` number, required
    - `coverageDuration` number, required
    - `generateTime` string, date-time, required
    - `dueTime` string, date-time, required
    - `invoiceLocator` string, ulid
    - `createdAt` string, date-time, required
    - `createdBy` string, uuid, required
    - `updatedAt` string, date-time, required
    - `updatedBy` string, uuid, required
    - `installmentItems` InstallmentItem[], required
      - `locator` string, ulid, required
      - `installmentLocator` string, ulid, required
      - `chargeLocator` string, ulid, required
      - `elementLocator` string, ulid, required
      - `elementStaticLocator` string, ulid, required
      - `chargeType` string, required
      - `chargeCategory` string, required
      - `amount` number, required
      - `invoiceItemLocator` string, ulid
      - `createdAt` string, date-time, required
      - `createdBy` string, uuid, required
      - `reversalOfInstallmentItemLocator` string, ulid
    - `reversalOfInstallmentLocator` string, ulid
    - `termLocator` string, ulid
    - `migratedFromInstallmentLocator` string, ulid
    - `autopayTime` string, date-time
    - `enhancedByPlugin` boolean
  - `accountLocator` string, ulid, required
  - `quoteLocator` string, ulid
  - `policyLocator` string, ulid
  - `transactionLocator` string, ulid
  - `queuedPolicyCharges` ChargeQueueItem[], required
    - `chargeLocator` string, ulid, required
    - `accountLocator` string, ulid, required
    - `invoiceItemLocator` string, ulid
    - `chargeSource` 'billing' | 'policy', required
    - `currency` string, required
    - `amount` number, required
    - `chargeType` string, required
    - `chargeMetadata` ChargeMetadata, required
      - `policyLocator` string, ulid
      - `transactionLocator` string, ulid
      - `elementStaticLocator` string, ulid
      - `timezone` string
      - `invoicing` 'scheduled' | 'next' | 'immediate'
  - `durationBasis` 'years' | 'months' | 'weeks' | 'days' | 'hours', required
  - `settings` Settings, required
    - `locator` string, ulid, required
    - `installmentSettings` InstallmentSettings, required
      - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays', required
      - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay', required
      - `generateLeadDays` integer, required
      - `dueLeadDays` integer, required
      - `installmentWeights` number[], required
      - `maxInstallmentsPerTerm` integer
      - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
      - `dayOfMonth` integer
      - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
      - `anchorTime` string, date-time
      - `autopayLeadDays` number
    - `createdAt` string, date-time, required
    - `createdBy` string, uuid, required
  - `persistedInstallmentLocators` string[], required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)
