Skip to main content
PATCH
Update recurring payment

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