plaid

Get Cash Advance income insights

Changed on

The /beta/cash_advance/income_insights/v1/get endpoint returns a user's top income streams across all of the user's active Items, ranked by historical net monthly income and capped at three, along with the next payment date and amount of the highest-ranked stream.

Only USD income streams are returned. If some, but not all, of the user's Items could not be evaluated, the response is based on the remaining Items.

post/beta/cash_advance/income_insights/v1/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/cash_advance/income_insights/v1/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

user_idstring required

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

next_payment_datestring date nullable required

The next payment date of the highest-ranked income stream, in ISO 8601 format (YYYY-MM-DD). null if the user has no income streams.

next_payment_amountnumber double nullable required

The historical net monthly income of the highest-ranked income stream. null if the user has no income streams.

iso_currency_codestring nullable required

The ISO-4217 currency code of next_payment_amount. Always USD when next_payment_amount is set, and null otherwise.

Changes