Skip to main content
PATCH
/
cases
/
{case_id}
/
bank-accounts
/
{account_id}
/
recurring-payments
/
{payment_id}
Update recurring payment
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/recurring-payments/{payment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payee_name": "<string>",
  "type": "direct_deposit",
  "amount": 123,
  "frequency": "weekly",
  "next_payment_date": "2023-12-25",
  "last_payment_date": "2023-12-25",
  "status": "active",
  "cancellation_date": "2023-12-25",
  "cancelled_by": "<string>",
  "notes": "<string>"
}
'
{
  "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",
    "cancellation_date": "2023-12-25",
    "cancelled_by": "<string>",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api.hellosunset.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
account_id
string
required
​
payment_id
string
required

Body

application/json
​
payee_name
string
required
​
type
enum<string>
required
Available options:
direct_deposit,
autopay,
subscription,
loan_payment,
insurance_premium,
utility,
pension,
social_security,
annuity
​
amount
number<double>
required
​
frequency
enum<string>
required
Available options:
weekly,
biweekly,
monthly,
quarterly,
annually
​
next_payment_date
string<date>
​
last_payment_date
string<date>
​
status
enum<string>
Available options:
active,
cancelled,
paused,
transferred
​
cancellation_date
string<date>
​
cancelled_by
string
​
notes
string

Response

Recurring payment updated.

​
data
object