Attribute | ​ | Type | ​ | Description |
id | ​ | number | ​ | Unique identifier for recurring expense |
start_date | ​ | string | ​ | Denotes when recurring expense starts occurring in ISO 8601 format. If null, then this recurring expense will show up for all time before end_date |
end_date | ​ | string | ​ | Denotes when recurring expense stops occurring in ISO 8601 format. If null, then this recurring expense has no set end date and will show up for all months after start_date |
cadence | ​ | string | ​ | One of:
|
payee | ​ | string | ​ | Payee of the recurring expense |
amount | ​ | number | ​ | Amount of the recurring expense in numeric format to 4 decimal places |
currency | ​ | string | ​ | Three-letter lowercase currency code for the recurring expense |
description | ​ | string | ​ | If any, represents the user-entered description of the recurring expense |
billing_date | ​ | string | ​ | Expected billing date for this recurring expense for this month in ISO 8601 format |
type | ​ | string | ​ | This can be one of two values:
|
original_name | ​ | string | ​ | If any, represents the original name of the recurring expense as denoted by the transaction that triggered its creation |
source | ​ | string | ​ | This can be one of three values:
Some older recurring expenses may not have a source. |
plaid_account_id | ​ | number | ​ | If any, denotes the plaid account associated with the creation of this recurring expense (see Plaid Accounts) |
asset_id | ​ | number | ​ | If any, denotes the manually-managed account (i.e. asset) associated with the creation of this recurring expense (see Assets) |
transaction_id | ​ | number | ​ | If any, denotes the unique identifier for the associated transaction matching this recurring expense for the current time period |
category_id | ​ | number | ​ | If any, denotes the unique identifier for the associated category to this recurring expense |