Skip to main content
Detects and returns recurring financial patterns from connected bank accounts, including subscriptions, bills, and recurring income deposits.

​
Parameters

ParameterTypeRequiredDefaultDescription
statusstringNoactiveFilter by status: active, inactive, irregular, or all

​
Response

The response separates recurring transactions into inflows (income) and outflows (expenses).

​
Outflow fields

FieldTypeDescription
source_namestringMerchant or service name
categoriesarrayAssigned categories
frequencystringWEEKLY, BIWEEKLY, MONTHLY, etc.
average_amountstringAverage payment amount
last_amountstringMost recent payment amount
statusstringactive, inactive, or irregular
next_expected_datestringPredicted next payment date
historical_transactionsarrayPast transactions for this source

​
Inflow fields

FieldTypeDescription
source_namestringIncome source name
frequencystringPayment frequency
average_amountstringAverage payment amount
income_typestringType of income (e.g. salary)
statusstringactive or inactive
next_expected_datestringPredicted next payment date

​
Example

Prompt: “Show me all my active subscriptions” Called with status: "active": 
{
  "outflows": [
    {
      "source_name": "Netflix",
      "categories": ["Entertainment"],
      "frequency": "MONTHLY",
      "average_amount": "15.99",
      "last_amount": "15.99",
      "status": "active",
      "next_expected_date": "2026-05-01"
    },
    {
      "source_name": "Spotify",
      "categories": ["Entertainment"],
      "frequency": "MONTHLY",
      "average_amount": "10.99",
      "last_amount": "10.99",
      "status": "active",
      "next_expected_date": "2026-04-15"
    }
  ],
  "inflows": [
    {
      "source_name": "Employer Direct Deposit",
      "frequency": "BIWEEKLY",
      "average_amount": "3250.00",
      "income_type": "salary",
      "status": "active",
      "next_expected_date": "2026-04-11"
    }
  ]
}