---
title: "Update Term"
method: PATCH
path: "/api/invoice-schedules/{schedule_id}/terms/{term_id}"
tags: ["invoice-schedules"]
---

# Update Term

`PATCH /api/invoice-schedules/{schedule_id}/terms/{term_id}`

## Request

- Base URL: `https://demo.usesecuro.com` (the document declares no server; this is the origin it was published from)
- URL: `https://demo.usesecuro.com/api/invoice-schedules/{schedule_id}/terms/{term_id}`
- Auth: OAuth 2
  - Password
  - Token URL: `/api/auth/login`
- TypeScript: <https://skmtc.dev/usesecuro/apis/securo/docs/api/invoice-schedules/:schedule_id/terms/:term_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `schedule_id` string, uuid, required
- `term_id` string, uuid, required

## Headers

- `X-Workspace-Id` string, nullable

## Request body

- ScheduleTermUpdate
  - `effective_from` string, date, nullable
  - `lines` InvoiceLineInput[], nullable
    - `description` string, required
    - `quantity` union
      - number
      - string
    - `unit` string, nullable
    - `unit_price` union
      - number
      - string
    - `tax_rate` union
      - number
      - string
    - `product_id` string, uuid, nullable
    - `price_id` string, uuid, nullable
    - `fiscal_refs` object, nullable
  - `discount` union
    - number
    - string

## Response `200`

Successful Response

- ScheduleRead
  - `id` string, uuid, required
  - `name` string, required
  - `payee_id` string, uuid, nullable, required
  - `payee` InvoicePayee
    - `id` string, uuid, required
    - `name` string, required
  - `origin` string, required
  - `external_source` string, nullable
  - `external_id` string, nullable
  - `status` 'active' | 'paused' | 'ended', required
  - `pause_reason` 'manual' | 'failures', nullable
  - `ended_at` string, date, nullable
  - `end_reason` 'canceled_by_client' | 'canceled_by_us' | 'completed' | 'unpaid' | 'other', nullable
  - `frequency` 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly', required
  - `start_date` string, date, required
  - `end_type` 'never' | 'on_date' | 'after_count', required
  - `end_date` string, date, nullable
  - `end_count` integer, nullable
  - `payment_terms_days` integer, nullable
  - `currency` string, required
  - `notes` string, nullable
  - `custom_fields` object, nullable
  - `next_sequence` integer, required
  - `last_generated_at` string, date-time, nullable
  - `consecutive_failures` integer, required
  - `terms` ScheduleTermRead[]
    - `id` string, uuid, required
    - `effective_from` string, date, required
    - `lines` object[], required
    - `discount` string, required
    - `subtotal` string, required
    - `tax_total` string, required
    - `total` string, required
    - `created_at` string, date-time, required
  - `created_at` string, date-time, required
  - `current_term` ScheduleTermRead
    - `id` string, uuid, required
    - `effective_from` string, date, required
    - `lines` object[], required
    - `discount` string, required
    - `subtotal` string, required
    - `tax_total` string, required
    - `total` string, required
    - `created_at` string, date-time, required
  - `next_term` ScheduleTermRead
    - `id` string, uuid, required
    - `effective_from` string, date, required
    - `lines` object[], required
    - `discount` string, required
    - `subtotal` string, required
    - `tax_total` string, required
    - `total` string, required
    - `created_at` string, date-time, required
  - `monthly_amount` string
  - `next_period_start` string, date, nullable
  - `invoice_count` integer
  - `amount_invoiced` string
  - `amount_paid` string
  - `past_due_count` integer

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-05** `416a7752fec4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usesecuro/apis/securo/changes/api/invoice-schedules/:schedule_id/terms/:term_id/patch.md)

---

[API](https://skmtc.dev/usesecuro/apis/securo.md) - [All operations](https://skmtc.dev/usesecuro/apis/securo/llms.txt) - [OpenAPI document](https://skmtc.dev/usesecuro/apis/securo/revisions/416a7752fec4?raw)