get_recurring_transactions
Identify recurring and subscription charges by combining merchant pattern analysis with user-confirmed Copilot subscriptions to return frequency, confidence, and next expected date.
Instructions
Identify recurring/subscription charges. Combines two data sources: (1) Pattern analysis - finds transactions from same merchant with similar amounts, returns estimated frequency, confidence score, and next expected date. (2) Copilot's native subscription tracking - returns user-confirmed subscriptions stored in the app. Both sources are included by default for comprehensive coverage. Rows in the pattern-analysis recurring array are terse by default: merchant, normalized_merchant, occurrences, average_amount, total_amount, frequency, confidence, category_name, last_date, next_expected_date. That excludes the matched transactions array (already reachable via get_transactions) and confidence_reason (prose explaining the score) — see fields for how to get either back.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by name (case-insensitive partial match). When filtering, returns detailed view with additional fields like min_amount, max_amount, match_string, account info, and transaction history. | |
| fields | No | Return only these fields per detected recurring merchant. Default when omitted omits two expensive fields: `transactions` (the matched date/amount pairs, ~29% of a row) and `confidence_reason` (prose explaining the confidence score, ~15%). `confidence` itself is always in the default. Request the rest with fields: ["default", "transactions", "confidence_reason"], or "all" / "*" for full rows. Unknown names are omitted and reported via _field_warning. | |
| period | No | Period to analyze (default: last_90_days). Options: this_month, last_month, last_7_days, last_30_days, last_90_days, ytd, this_year, last_year | |
| end_date | No | End date (YYYY-MM-DD) | |
| start_date | No | Start date (YYYY-MM-DD) | |
| recurring_id | No | Filter by exact recurring ID. When filtering, returns detailed view with additional fields like min_amount, max_amount, match_string, account info, and transaction history. | |
| min_occurrences | No | Minimum number of occurrences to qualify as recurring (default: 2) | |
| include_copilot_subscriptions | No | Include Copilot's native subscription tracking data (default: true). Returns copilot_subscriptions array with user-confirmed subscriptions. |