Update Recurring Transaction
update_recurring_transactionAdjust a merchant's recurring schedule—frequency, amount, active status, or anchor date—without renaming or affecting individual transactions.
Instructions
Change a merchant's recurring schedule, not an individual transaction.
This affects the merchant-wide recurrence. Get merchant_id from an occurrence's stream.merchant.id, not stream.id or transactionId. Pass the current merchant_name to avoid renaming the merchant.
Omitted settings stay unchanged; provide at least one. is_recurring enables or removes recurrence; is_active pauses or resumes a schedule. frequency is Monarch's string (for example, "monthly"). base_date is the schedule's anchor date and accepts the same date formats as get_recurring_transactions. amount uses Monarch's signed amount, as returned by the existing stream. This does not create posted transactions or move money.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | ||
| base_date | No | ||
| frequency | No | ||
| is_active | No | ||
| merchant_id | Yes | ||
| is_recurring | No | ||
| merchant_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| merchant | Yes |