Get Recurring Streams
get_recurring_streamsList recurring merchant schedules with next forecasts to review bills, subscriptions, and liabilities; optionally filter to active streams or include paused and credit-report items.
Instructions
List every recurring stream (merchant schedule) with its next forecast.
Args: active_only: True skips paused streams. include_liabilities: True includes credit-report liability streams such as loans and cards. verbose: True returns the full upstream objects.
Compact rows: id, name, merchant {id, name}, frequency, amount, is_approximate, is_active, review_status, recurring_type, base_date, next_date, next_amount, category, category_id, account, account_id. merchant.id and merchant.name feed update_recurring_transaction. Forecasts are expectations, not posted transactions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verbose | No | ||
| active_only | No | ||
| include_liabilities | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| streams | Yes | ||
| verbose | Yes |