Fetch recurring transaction streams
The /transactions/recurring/get endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.
This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create; or after Link, by calling /transactions/get or /transactions/sync).
When using Recurring Transactions, for best results, make sure to use the days_requested parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call /transactions/recurring/get to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE webhook. To know when historical transactions have been fetched, if you are using /transactions/sync listen for the SYNC_UPDATES_AVAILABLE webhook and check that the historical_update_complete field in the payload is true. If using /transactions/get, listen for the HISTORICAL_UPDATE webhook.
After the initial call, you can call the /transactions/recurring/get endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE webhook to be notified when new updates are available.
Request body
Response
OK
Changes
Changed in 14 of the 52 revisions of this API.64032
- ●
added the new
ASSETS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CRA_MONITORING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CREDIT_PROFILE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENCOMPASS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENRICH_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FRAUD_INSIGHTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FREDDIE_MAC_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
LINK_DELIVERY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
PROFILE_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
RECURRING_TRANSACTIONS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
STATEMENTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_RECURRING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_REFUND_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
IDEMPOTENCY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
- ●
added the new
BASE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
request property
options/personal_finance_category_versionwas restricted to a list of enum valuesrequest-property-became-enum
- ●
added the new
v1enum value to theinflow_streams/items/personal_finance_category/versionresponse property for the response status200response-property-enum-value-added
- ●
added the new
v1enum value to theoutflow_streams/items/personal_finance_category/versionresponse property for the response status200response-property-enum-value-added
- ●
added the new
v1enum value to thepersonal_finance_category_versionresponse property for the response status200response-property-enum-value-added
- ●
added the new
v2enum value to theinflow_streams/items/personal_finance_category/versionresponse property for the response status200response-property-enum-value-added
- ●
added the new
v2enum value to theoutflow_streams/items/personal_finance_category/versionresponse property for the response status200response-property-enum-value-added
- ●
added the new
v2enum value to thepersonal_finance_category_versionresponse property for the response status200response-property-enum-value-added
- ○
added the new
v1enum value to the request propertyoptions/personal_finance_category_versionrequest-property-enum-value-added
- ○
added the new
v2enum value to the request propertyoptions/personal_finance_category_versionrequest-property-enum-value-added
- ○
added the optional property
provided_account_subtypesto the response with thedefaultstatusresponse-optional-property-added
- ○
added the optional property
required_account_subtypesto the response with thedefaultstatusresponse-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
removed the
IDENTITY_ERRORenum value from theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-removed
- ○
- ●
added the new
IDENTITY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
USER_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
SIGNAL_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
- ○
added the new optional request property
options/personal_finance_category_versionnew-optional-request-property
- ○
added the optional property
inflow_streams/items/personal_finance_category/versionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
outflow_streams/items/personal_finance_category/versionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
personal_finance_category_versionto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response property
inflow_streams/items/categorybecame nullable for the status200response-property-became-nullable
- ▲
the response property
inflow_streams/items/category_idbecame nullable for the status200response-property-became-nullable
- ▲
the response property
outflow_streams/items/categorybecame nullable for the status200response-property-became-nullable
- ▲
the response property
outflow_streams/items/category_idbecame nullable for the status200response-property-became-nullable
- ▲
- ●
added the new
CHECK_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CONSUMER_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ○
response property
inflow_streams/items/is_user_modifieddeprecatedresponse-property-deprecated
- ○
response property
inflow_streams/items/last_user_modified_datetimedeprecatedresponse-property-deprecated
- ○
response property
outflow_streams/items/is_user_modifieddeprecatedresponse-property-deprecated
- ○
response property
outflow_streams/items/last_user_modified_datetimedeprecatedresponse-property-deprecated
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●