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:
active,
inactive
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
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