---
title: "Get Cash Advance income insights"
method: POST
path: "/beta/cash_advance/income_insights/v1/get"
tags: ["plaid"]
---

# Get Cash Advance income insights

`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`

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.

## Request body

- BetaCashAdvanceIncomeInsightsV1GetRequest: BetaCashAdvanceIncomeInsightsV1GetRequest defines the request schema for `/beta/cash_advance/income_insights/v1/get`
  - `client_id` string: 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.
  - `secret` string: 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_id` string, 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](https://plaid.com/docs/api/users/user-apis).

## Response `200`

OK

- BetaCashAdvanceIncomeInsightsV1GetResponse: BetaCashAdvanceIncomeInsightsV1GetResponse defines the response schema for `/beta/cash_advance/income_insights/v1/get`
  - `request_id` string, required: A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
  - `next_payment_date` string, 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_amount` number, double, nullable, required: The historical net monthly income of the highest-ranked income stream. `null` if the user has no income streams.
  - `iso_currency_code` string, nullable, required: The ISO-4217 currency code of `next_payment_amount`. Always `USD` when `next_payment_amount` is set, and `null` otherwise.
  - `income_streams` CashAdvanceIncomeStream[], required: The user's top income streams, ranked by historical net monthly income. Contains at most three streams, and is empty if the user has no income.
    - `provider_name` string, nullable, required: The name of the income provider, such as an employer or benefits agency. `null` if the provider could not be identified.
    - `category` CashAdvanceIncomeCategory, nullable, required: The category of an income stream.
      - `primary` string, nullable, required: The primary income category, for example `EARNED_INCOME`, `RETIREMENT`, or `BENEFITS`. `null` if the category could not be determined.
    - `pay_frequency` 'WEEKLY' | 'BIWEEKLY' | 'SEMI_MONTHLY' | 'MONTHLY' | 'ANNUALLY' | 'DAILY' | 'DYNAMIC' | 'null', nullable, required: The pay cadence of an income stream. `DYNAMIC` means the income recurs, but not on a regular schedule. `null` if the pay frequency could not be determined.
    - `iso_currency_code` string, nullable, required: The ISO-4217 currency code of the income stream. Always `USD`.

## Other responses

- `default`: Error response

## Changes

- **2026-10-15** `ea443cd78f6f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/beta/cash_advance/income_insights/v1/get/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) - [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) - [OpenAPI document](https://skmtc.dev/plaid/apis/the-plaid-api/revisions/ea443cd78f6f?raw)