Upgrading plaid from 48.x to 49.x

Comparison of the public API of plaid 48.0.0 and 49.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	69
Changed signatures	3
Removed class or interface members	4
Changed class or interface members	59
Newly deprecated	0
Requirement changes (engines, peer dependencies)	0
New exports	69

Removed exports

import	export	kind	Before
`plaid`	`Paystub`	interface	`interface`
`plaid`	`PhoneType`	enum	`PhoneType`
`plaid`	`PlaidError`	interface	`interface`
`plaid`	`PayrollItem`	interface	`interface`
`plaid`	`PhoneNumber`	interface	`interface`
`plaid`	`PlatformIds`	interface	`interface`
`plaid`	`PrismDetect`	interface	`interface`
`plaid`	`PrismExtend`	interface	`interface`
`plaid`	`Enhancements`	interface	`interface`
`plaid`	`PaymentScheme`	enum	`PaymentScheme`
`plaid`	`PrismInsights`	interface	`interface`
`plaid`	`PrismVersions`	interface	`interface`
`plaid`	`PaystubAddress`	interface	`interface`
`plaid`	`PaystubDetails`	interface	`interface`
`plaid`	`PlaidErrorType`	enum	`PlaidErrorType`
`plaid`	`PrismCashScore`	interface	`interface`
`plaid`	`PaystubEmployer`	interface	`interface`
`plaid`	`PaystubOverride`	interface	`interface`
`plaid`	`PaystubDeduction`	interface	`interface`
`plaid`	`PrismFirstDetect`	interface	`interface`
`plaid`	`PayrollItemStatus`	interface	`interface`
`plaid`	`PaystubYTDDetails`	interface	`interface`
`plaid`	`PrismDetectVersion`	enum	`PrismDetectVersion`
`plaid`	`PrismExtendVersion`	enum	`PrismExtendVersion`
`plaid`	`PayrollIncomeObject`	interface	`interface`
`plaid`	`PaystubPayFrequency`	enum	`PaystubPayFrequency`
`plaid`	`PhoneNumberTypeEnum`	enum	`PhoneNumberTypeEnum`
`plaid`	`PaymentProfileStatus`	enum	`PaymentProfileStatus`
`plaid`	`PrismInsightsVersion`	enum	`PrismInsightsVersion`
`plaid`	`PaystubOverrideNetPay`	interface	`interface`
`plaid`	`PhoneNumberMatchScore`	interface	`interface`
`plaid`	`PlaidLendScoreVersion`	enum	`PlaidLendScoreVersion`
`plaid`	`PrismCashScoreVersion`	enum	`PrismCashScoreVersion`
`plaid`	`PayrollIncomeRateOfPay`	interface	`interface`
`plaid`	`PayrollRiskSignalsItem`	interface	`interface`
`plaid`	`PhysicalDocumentImages`	interface	`interface`
`plaid`	`PrismCashScoreMetadata`	interface	`interface`
`plaid`	`PaymentScheduleInterval`	enum	`PaymentScheduleInterval`
`plaid`	`PaystubOverrideEarnings`	interface	`interface`
`plaid`	`PaystubOverrideEmployee`	interface	`interface`
`plaid`	`PaystubOverrideEmployer`	interface	`interface`
`plaid`	`PersonalFinanceCategory`	interface	`interface`
`plaid`	`PrismFirstDetectVersion`	enum	`PrismFirstDetectVersion`
`plaid`	`PayrollIncomeAccountData`	interface	`interface`
`plaid`	`PendingDisconnectWebhook`	interface	`interface`
`plaid`	`PendingExpirationWebhook`	interface	`interface`
`plaid`	`PhysicalDocumentCategory`	enum	`PhysicalDocumentCategory`
`plaid`	`PaystubOverrideDeductions`	interface	`interface`
`plaid`	`PaystubOverrideTaxpayerID`	interface	`interface`
`plaid`	`PaymentStatusUpdateWebhook`	interface	`interface`
`plaid`	`ClientProvidedRawTransaction`	interface	`interface`
`plaid`	`PaymentProfileRemoveResponse`	interface	`interface`
`plaid`	`PaystubOverrideEarningsTotal`	interface	`interface`
`plaid`	`PhysicalDocumentExtractedData`	interface	`interface`
`plaid`	`PaystubOverrideDeductionsTotal`	interface	`interface`
`plaid`	`PaystubOverrideEmployeeAddress`	interface	`interface`
`plaid`	`PaystubOverrideEmployerAddress`	interface	`interface`
`plaid`	`PendingDisconnectWebhookReason`	enum	`PendingDisconnectWebhookReason`
`plaid`	`PersonalFinanceCategoryVersion`	enum	`PersonalFinanceCategoryVersion`
`plaid`	`PaystubOverridePayPeriodDetails`	interface	`interface`
`plaid`	`PaystubOverrideEarningsBreakdown`	interface	`interface`
`plaid`	`ClientProvidedEnhancedTransaction`	interface	`interface`
`plaid`	`CraReportCreateHomeLendingOptions`	interface	`interface`
`plaid`	`PaystubOverrideDeductionsBreakdown`	interface	`interface`
`plaid`	`CraReportCreateHomeLendingReportType`	enum	`CraReportCreateHomeLendingReportType`
`plaid`	`PaystubOverrideDistributionBreakdown`	interface	`interface`
`plaid`	`PhysicalDocumentExtractedDataAnalysis`	interface	`interface`
`plaid`	`CraReportCreateEmploymentRefreshOptions`	interface	`interface`
`plaid`	`CraReportGetIncomeInsightsMetadataAllOf`	interface	`interface`

Changed signatures

export	Before	After
`plaid · CraReportProduct`	`CraReportCreateBaseReportProductConfig \| CraReportCreateCashflowInsightsProductConfig \| CraReportCreateHomeLendingProductConfig \| CraReportCreateIncomeInsightsProductConfig \| CraReportCreateLendScoreProductConfig \| CraReportCreateNetworkInsightsProductConfig \| CraReportCreateQualifyProductConfig`	`CraReportCreateBaseReportProductConfig \| CraReportCreateCashflowInsightsProductConfig \| CraReportCreateHomeLendingProductConfig \| CraReportCreateIncomeCompleteBundleProductConfig \| CraReportCreateIncomeInsightsProductConfig \| CraReportCreateLendScoreCompleteBundleProductConfig \| CraReportCreateLendScoreProductConfig \| CraReportCreateNetworkInsightsProductConfig \| CraReportCreateQualifyProductConfig`
`plaid · CraReportGetRequestProduct`	`CraBaseReportProduct \| CraCashflowInsightsProduct \| CraHomeLendingProduct \| CraIncomeInsightsProduct \| CraLendScoreProduct \| CraNetworkInsightsProduct \| CraQualifyProduct`	`CraBaseReportProduct \| CraCashflowInsightsProduct \| CraHomeLendingProduct \| CraIncomeCompleteBundleProduct \| CraIncomeInsightsProduct \| CraLendScoreCompleteBundleProduct \| CraLendScoreProduct \| CraNetworkInsightsProduct \| CraQualifyProduct`
`plaid · CraReportGetResponseProduct`	`CraReportGetHomeLendingResponseProduct \| CraReportGetIncomeInsightsResponseProduct \| CraReportGetQualifyResponseProduct`	`CraReportGetBaseReportResponseProduct \| CraReportGetCashflowInsightsResponseProduct \| CraReportGetHomeLendingResponseProduct \| CraReportGetIncomeCompleteResponseProduct \| CraReportGetIncomeInsightsResponseProduct \| CraReportGetLendScoreCompleteResponseProduct \| CraReportGetLendScoreResponseProduct \| CraReportGetNetworkInsightsResponseProduct \| CraReportGetQualifyResponseProduct`

Removed class or interface members

member	import	Before
`AssetReportInvestmentHolding.cost_basis`	`plaid`	`number \| null`
`AssetReportInvestmentTransaction.vested_value`	`plaid`	`number`
`AssetReportInvestmentTransaction.vested_quantity`	`plaid`	`number`
`CraReportCreateHomeLendingProductConfig.options`	`plaid`	`CraReportCreateHomeLendingOptions \| null \| undefined`

Changed class or interface members

member	Before	After
`MFA.question_rounds`	`number`	`number \| undefined`
`MFA.selection_rounds`	`number`	`number \| undefined`
`MFA.questions_per_round`	`number`	`number \| undefined`
`MFA.selections_per_question`	`number`	`number \| undefined`
`Meta.mask`	`string`	`string \| undefined`
`Meta.name`	`string`	`string \| undefined`
`Meta.limit`	`number`	`number \| undefined`
`Meta.official_name`	`string`	`string \| undefined`
`AssetReport.insights`	`AccountInsights \| null \| undefined`	`AccountInsights \| undefined`
`InflowModel.income_amount`	`number`	`number \| undefined`
`InflowModel.transaction_name`	`string`	`string \| undefined`
`InflowModel.payment_day_of_month`	`number`	`any`
`InflowModel.statement_day_of_month`	`string`	`any`
`OwnerOverride.emails`	`Email[]`	`Email[] \| undefined`
`OwnerOverride.addresses`	`Address[]`	`AddressOverride[] \| undefined`
`OwnerOverride.phone_numbers`	`PhoneNumber[]`	`PhoneNumber[] \| undefined`
`OverrideAccounts.meta`	`Meta`	`Meta \| undefined`
`OverrideAccounts.numbers`	`Numbers`	`Numbers \| undefined`
`OverrideAccounts.currency`	`string`	`string \| undefined`
`OverrideAccounts.holdings`	`HoldingsOverride \| undefined`	`HoldingsOverride[] \| undefined`
`OverrideAccounts.identity`	`OwnerOverride`	`OwnerOverride \| undefined`
`OverrideAccounts.liability`	`LiabilityOverride`	`LiabilityOverride \| undefined`
`OverrideAccounts.inflow_model`	`InflowModel`	`InflowModel \| undefined`
`OverrideAccounts.transactions`	`TransactionOverride[]`	`TransactionOverride[] \| undefined`
`OverrideAccounts.starting_balance`	`number`	`number \| undefined`
`OverrideAccounts.force_available_balance`	`number`	`number \| undefined`
`OverrideAccounts.investment_transactions`	`InvestmentsTransactionsOverride \| undefined`	`InvestmentsTransactionsOverride[] \| undefined`
`OverrideAccounts.has_null_available_balance`	`boolean`	`boolean \| undefined`
`LiabilityOverride.cash_apr`	`number`	`number \| undefined`
`LiabilityOverride.guarantor`	`string`	`string \| undefined`
`LiabilityOverride.loan_name`	`string`	`string \| undefined`
`LiabilityOverride.principal`	`number`	`number \| undefined`
`LiabilityOverride.is_federal`	`boolean`	`boolean \| undefined`
`LiabilityOverride.is_overdue`	`boolean`	`boolean \| undefined`
`LiabilityOverride.loan_status`	`StudentLoanStatus`	`StudentLoanStatus \| undefined`
`LiabilityOverride.nominal_apr`	`number`	`number \| undefined`
`LiabilityOverride.pslf_status`	`PSLFStatus`	`PSLFStatus \| undefined`
`LiabilityOverride.special_apr`	`number`	`number \| undefined`
`LiabilityOverride.purchase_apr`	`number`	`number \| undefined`
`LiabilityOverride.repayment_model`	`StudentLoanRepaymentModel`	`StudentLoanRepaymentModel \| undefined`
`LiabilityOverride.sequence_number`	`string`	`number \| undefined`
`LiabilityOverride.origination_date`	`string`	`string \| undefined`
`LiabilityOverride.servicer_address`	`Address`	`AddressDataOverride \| undefined`
`LiabilityOverride.last_payment_amount`	`number`	`number \| undefined`
`LiabilityOverride.repayment_plan_type`	`string`	`string \| undefined`
`LiabilityOverride.balance_transfer_apr`	`number`	`number \| undefined`
`LiabilityOverride.expected_payoff_date`	`string`	`string \| undefined`
`LiabilityOverride.minimum_payment_amount`	`number`	`number \| undefined`
`LiabilityOverride.payment_reference_number`	`string`	`string \| undefined`
`LiabilityOverride.repayment_plan_description`	`string`	`string \| undefined`
`LiabilityOverride.interest_capitalization_grace_period_months`	`number`	`number \| undefined`
`CraReportGetResponse.client_user_id`	`string \| null \| undefined`	`string \| null`
`CraReportCreateRequest.scope`	`CraReportScope \| undefined`	`CraReportScope`
`IdentityMatchListAttempt.item_id`	`string`	`string \| null`
`PaymentInitiationMetadata.maximum_payment_amount`	`{ [key: string]: string; }`	`{ [key: string]: string; } \| undefined`
`IdentityMatchListAttemptScore.account_id`	`string`	`string \| null`
`PaymentInitiationStandingOrderMetadata.valid_standing_order_intervals`	`PaymentScheduleInterval[]`	`PaymentScheduleInterval[] \| null`
`LinkTokenCreateRequestCraReportParameter.scope`	`CraReportScope \| undefined`	`CraReportScope`
`LinkTokenCreateRequestCraReportParameter.decision_stage`	`CraReportDecisionStage \| undefined`	`CraReportDecisionStage`

Newly deprecated

None detected.

Requirement changes (engines, peer dependencies)

None detected.

New exports (69)

import	export	kind
`plaid`	`AddressOverride`	interface
`plaid`	`AddressDataOverride`	interface
`plaid`	`CraLendScoreVariant`	enum
`plaid`	`KYCCheckSSAAnalysis`	interface
`plaid`	`CraReportGetBaseItem`	interface
`plaid`	`LiabilityOverrideAPR`	interface
`plaid`	`KYCCheckSSAMatchStatus`	enum
`plaid`	`CashAdvanceIncomeStream`	interface
`plaid`	`CashAdvancePayFrequency`	enum
`plaid`	`CraReportGetBaseAccount`	interface
`plaid`	`CraReportGetEnrichedItem`	interface
`plaid`	`LiabilityOverrideAPRType`	enum
`plaid`	`CashAdvanceIncomeCategory`	interface
`plaid`	`CraReportGetBaseReportItem`	interface
`plaid`	`CraReportGetEnrichedAccount`	interface
`plaid`	`CraReportGetLendScoreOptions`	interface
`plaid`	`CraReportGetBaseReportAccount`	interface
`plaid`	`CraReportGetEnrichedItemAllOf`	interface
`plaid`	`CraReportGetLendScoreMetadata`	interface
`plaid`	`LiabilityOverrideInterestRate`	interface
`plaid`	`CraIncomeCompleteBundleProduct`	interface
`plaid`	`CraReportGetBaseReportMetadata`	interface
`plaid`	`CraReportCreateLendScoreOptions`	interface
`plaid`	`CraReportGetAccountIdentityMatch`	interface
`plaid`	`CraReportGetBaseReportAttributes`	interface
`plaid`	`CraReportGetEnrichedAccountAllOf`	interface
`plaid`	`CraLendScoreCompleteBundleProduct`	interface
`plaid`	`CraReportGetAccountPrimaryAccount`	interface
`plaid`	`CraReportGetBaseReportTransaction`	interface
`plaid`	`CraReportGetLendScoreVariantScore`	interface
`plaid`	`LiabilityOverrideInterestRateType`	enum
`plaid`	`CraReportGetIncomeCompleteMetadata`	interface
`plaid`	`CraReportGetLendScoreMetadataAllOf`	interface
`plaid`	`CraReportGetBaseReportMetadataAllOf`	interface
`plaid`	`CraReportGetNetworkInsightsMetadata`	interface
`plaid`	`CraReportCreateIncomeCompleteOptions`	interface
`plaid`	`CraReportGetCashflowInsightsMetadata`	interface
`plaid`	`CraReportGetIncomeCompleteAttributes`	interface
`plaid`	`CraReportGetLendScoreCompleteOptions`	interface
`plaid`	`CraReportGetLendScoreResponseProduct`	interface
`plaid`	`CraReportGetBaseReportAccountBalances`	interface
`plaid`	`CraReportGetBaseReportAccountInsights`	interface
`plaid`	`CraReportGetBaseReportResponseProduct`	interface
`plaid`	`CraReportGetLendScoreCompleteMetadata`	interface
`plaid`	`CraReportCreateLendScoreCompleteOptions`	interface
`plaid`	`CraReportGetBaseReportAccountAttributes`	interface
`plaid`	`CraReportGetBaseReportLongestGapInsight`	interface
`plaid`	`CraReportGetLendScoreCompleteAttributes`	interface
`plaid`	`BetaCashAdvanceIncomeInsightsV1GetRequest`	interface
`plaid`	`CraIncomeCompleteBundleProductProductEnum`	enum
`plaid`	`CraReportGetIncomeCompleteResponseProduct`	interface
`plaid`	`BetaCashAdvanceIncomeInsightsV1GetResponse`	interface
`plaid`	`CraReportGetBaseReportAccountIdentityMatch`	interface
`plaid`	`CraReportGetLendScoreCompleteMetadataAllOf`	interface
`plaid`	`CraReportGetNetworkInsightsResponseProduct`	interface
`plaid`	`CraReportGetBaseReportAverageMonthlyBalance`	interface
`plaid`	`CraReportGetCashflowInsightsResponseProduct`	interface
`plaid`	`CraLendScoreCompleteBundleProductProductEnum`	enum
`plaid`	`CraReportGetLendScoreCompleteResponseProduct`	interface
`plaid`	`CraReportGetLendScoreResponseProductProductEnum`	enum
`plaid`	`CraReportCreateIncomeCompleteBundleProductConfig`	interface
`plaid`	`CraReportGetBaseReportResponseProductProductEnum`	enum
`plaid`	`CraReportCreateLendScoreCompleteBundleProductConfig`	interface
`plaid`	`CraReportGetIncomeCompleteResponseProductProductEnum`	enum
`plaid`	`CraReportGetNetworkInsightsResponseProductProductEnum`	enum
`plaid`	`CraReportGetCashflowInsightsResponseProductProductEnum`	enum
`plaid`	`CraReportGetLendScoreCompleteResponseProductProductEnum`	enum
`plaid`	`CraReportCreateIncomeCompleteBundleProductConfigProductEnum`	enum
`plaid`	`CraReportCreateLendScoreCompleteBundleProductConfigProductEnum`	enum

Changelog between these versions

Text published by the package authors, shown as-is.

49.0.0

- Updating to OAS 2020-09-14_1.778.0

## Breaking changes in this version

- [BREAKING] Correct Asset Report investment data to match API behavior: remove `cost_basis` from holdings, and move `vested_quantity` and `vested_value` from investment transactions to holdings as nullable fields.
- [BREAKING] Correct the capitalization of the enum values in the Auth and Identity `DEFAULT_UPDATE` webhooks to match the values the API sends.
- [BREAKING] Correct Sandbox enum values to match the values the API accepts: replace `VERIFICATION_STATUS_PENDING_APPROVAL` with `VERIFICATION_STATUS_DOCUMENT_REJECTED` in `/sandbox/income/fire_webhook`, and remove `PRODUCT_GENERATION_ERROR` from `/sandbox/cra/servicing/simulate`.
- [BREAKING] Remove `/sandbox/transfer/repayment/simulate` and `/beta/transactions/v1/enhance` from the specification to match the API, which no longer serves either endpoint.
- [BREAKING] Correct field types in the custom Sandbox user configuration (`UserCustomPassword`) to match what the Sandbox accepts. Client library models for these objects change type:
  - `version` is an integer, `1` or `2`.
  - `holdings` and `investment_transactions` on an `override_accounts` entry are arrays.
  - W2 amounts, including `box_12` and `state_and_local_wages` amounts, and `tax_year` in `income.w2s` are numbers, and `statutory_employee`, `retirement_plan`, and `third_party_sick_pay` are booleans.
  - `liability.sequence_number` is a number, and `liability.servicer_address` is a flat address with `street`, `city`, `region`, `postal_code`, and `country`, without the `primary` and `data` wrapper.
  - `inflow_model.payment_day_of_month` and `inflow_model.statement_day_of_month` take a whole number from 1 to 28 or the string `last`.
  - The credit APR fields and the student loan `nominal_apr` take a value from 0 to 100, and `interest_capitalization_grace_period_months` is a non-negative integer.
  - Remove `pay_frequency` from paystub `pay_period_details`. The Sandbox never read it.
- [BREAKING] In the custom Sandbox user configuration, mark as required only the fields the Sandbox requires: `type` and `subtype` on each account override; `type` on `mfa`, `liability`, and `inflow_model`; `names` on `identity`; `primary`, `data.city`, `data.street`, and `data.country` on each `identity.addresses` entry; `city`, `street`, and `country` on `liability.servicer_address`; and `currency` on a holding's or investment transaction's `security`. All top-level fields and all `meta` fields are optional.
- [BREAKING] Remove `primary_account`, `identity_match`, and `owners` from the accounts in the `cra_income_insights` product's `items` on `/cra/report/get`; Income Insights never populates them. Products that return identity data keep those fields.
- [BREAKING] Remove the public `options` object from `cra_home_lending` products on `/cra/report/create` and `cra_report_parameter.products` on `/link/token/create`, including the unsupported `reports_requested` and `employment_ref

Give your AI agent these facts

Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.

claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp

Add to Cursor Add to VS Code ★ Star on GitHub

Any other MCP client

{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }

Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests

Frequently asked questions

What are the breaking changes when upgrading plaid from 48 to 49?

Between plaid 48.0.0 and 49.0.0, Vigia found 69 removed exports, 3 changed signatures and 63 removed or changed class or interface members.

What became deprecated in plaid 49?

0 exports or members are newly marked as deprecated in plaid 49.0.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/plaid/upgrade?from=48.0.0&to=49.0.0