---
title: "PATCH /billing/{tenantLocator}/installments"
method: PATCH
path: "/billing/{tenantLocator}/installments"
---

# PATCH /billing/{tenantLocator}/installments

`PATCH /billing/{tenantLocator}/installments`

## Request

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

## Path parameters

- `tenantLocator` string, uuid, required

## Request body

- PatchInstallmentsRequest
  - `installmentLocators` string[], required
  - `generateTime` string, date-time
  - `dueTime` string, date-time
  - `autopayTime` string, date-time

## Response `200`

OK

- Installment[]
  - `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

---

[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/77ee7d8172b9?raw)