Skip to main content
PATCH
Update recurring transaction

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

id
string
required

Recurring transaction ID

Body

application/json
recurring_transaction
object

Response

recurring transaction updated

id
string<uuid>
required
amount
string
required
amount_cents
integer
required

Amount in currency minor units

currency
string
required
expected_day_of_month
integer
required
Required range: 1 <= x <= 31
last_occurrence_date
string<date>
required
next_expected_date
string<date>
required
status
enum<string>
required
Available options:
suggested,
active,
paused,
inactive,
ended
occurrence_count
integer
required
Required range: x >= 0
manual
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null
payment_url
string | null

Link to the biller portal where this bill is paid. Only http and https are accepted; a bare host is stored as https.

autopay
boolean

Whether this bill pays itself automatically.

notes
string | null

Free-text notes shown alongside the bill.

bill_type
enum<string>

What kind of obligation this is.

Available options:
bill,
subscription,
installment,
income,
transfer,
other
category_id
string<uuid> | null
anchor_date
string<date> | null

Reference occurrence that phases every-N cadences.

weekend_adjust
enum<string>
Available options:
none,
skip,
before,
after
end_mode
enum<string>
Available options:
never,
on_date,
after_count
end_on
string<date> | null
end_after_count
integer | null
renews_on
string<date> | null
trial_ends_on
string<date> | null
cancelled_on
string<date> | null
recurrence_rules
object[]

Repetition patterns; multiple rows express semimonthly and similar multi-pattern cadences. Empty means legacy monthly on expected_day_of_month.

expected_amount_min
string | null
expected_amount_min_cents
integer | null

Minimum expected amount in currency minor units

expected_amount_max
string | null
expected_amount_max_cents
integer | null

Maximum expected amount in currency minor units

expected_amount_avg
string | null
expected_amount_avg_cents
integer | null

Average expected amount in currency minor units

account
object | null
merchant
object | null