---
title: "Update recurring payment"
method: PATCH
path: "/cases/{case_id}/bank-accounts/{account_id}/recurring-payments/{payment_id}"
tags: ["Recurring Payments"]
---

# Update recurring payment

`PATCH /cases/{case_id}/bank-accounts/{account_id}/recurring-payments/{payment_id}`

## Request

- Base URL: `https://api.example.com/v1`
- URL: `https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/recurring-payments/{payment_id}`
- Auth: none declared

Update a recurring payment (e.g., mark as cancelled).

## Request body

- RecurringPaymentWrite
  - `payee_name` string, required
  - `type` 'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity', required
  - `amount` number, double, required
  - `frequency` 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually', required
  - `next_payment_date` string, date
  - `last_payment_date` string, date
  - `status` 'active' | 'cancelled' | 'paused' | 'transferred'
  - `cancellation_date` string, date
  - `cancelled_by` string
  - `notes` string

## Response `200`

Recurring payment updated.

- object
  - `data` RecurringPayment
    - `id` string
    - `payee_name` string
    - `type` 'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity'
    - `amount` number, double
    - `frequency` 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually'
    - `next_payment_date` string, date, nullable
    - `last_payment_date` string, date, nullable
    - `status` 'active' | 'cancelled' | 'paused' | 'transferred'
    - `cancellation_date` string, date, nullable
    - `cancelled_by` string, nullable
    - `notes` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `404`: Resource not found.
- `422`: Request validation failed.

---

[API](https://skmtc.dev/hellosunset/apis/sunset-api.md) - [All operations](https://skmtc.dev/hellosunset/apis/sunset-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hellosunset/apis/sunset-api/revisions/f128e5526efe?raw)