HEhellosunset
Recurring Payments

Update recurring payment

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

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

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Request body

payee_namestring required
type'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity' required
amountnumber double required
frequency'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually' required
next_payment_datestring date
last_payment_datestring date
status'active' | 'cancelled' | 'paused' | 'transferred'
cancellation_datestring date
cancelled_bystring
notesstring

Response

Recurring payment updated.

Example response

{
  "data": {
    "id": "01K6RP04DJ2T99HRYE78AN7YZA",
    "payee_name": "Springfield Electric Co.",
    "type": "utility",
    "amount": 150,
    "frequency": "monthly",
    "next_payment_date": "2025-10-15",
    "last_payment_date": "2025-09-15",
    "status": "active"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.