POST /user/products/terminate
Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a user_id. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
client_id |
String |
No |
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.
|
reason_code |
String |
Yes |
The reason for terminating products.
FRAUD_FIRST_PARTY: The end user who owns the connected bank account committed fraud using their real identity
FRAUD_FALSE_IDENTITY: The connection was created using a false or stolen identity
FRAUD_ABUSE: The end user is abusing the client's service or platform (for example, automation or excessive retries) through their connected account
FRAUD_OTHER: Fraud-related, but not covered by the specific fraud categories above; reason_note should clarify
FRAUD_TRANSACTION: Fraud occurred at the transaction level, such as an unauthorized transaction, card testing, chargeback, ACH return, or dispute
CONSUMER_LOAN_PAID_OFF: The end user paid off their loan and no longer needs the product
CONSUMER_ACCOUNT_CLOSED: The end user closed their account with the client and no longer needs the product
CONSUMER_CHARGE_OFF: The end user's account has been charged off
CONSUMER_PAYMENT_METHOD_SWITCHED: The end user switched to a different payment method and no longer needs the product
USER_OFFBOARDING: The user is offboarding from the client's service or platform
DUPLICATE_ITEM: This Item is a duplicate of another active Item for the same user
BILLING_TERMINATION: The client's billing or subscription relationship with the end user has ended
OTHER: None of the above; reason_note should clarify
Valid values:
"BILLING_TERMINATION""FRAUD_FIRST_PARTY""CONSUMER_LOAN_PAID_OFF""FRAUD_OTHER""CONSUMER_CHARGE_OFF""CONSUMER_ACCOUNT_CLOSED""OTHER""CONSUMER_PAYMENT_METHOD_SWITCHED""FRAUD_TRANSACTION""FRAUD_ABUSE""USER_OFFBOARDING""DUPLICATE_ITEM""FRAUD_FALSE_IDENTITY"
|
secret |
String |
No |
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 |
Yes |
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.
|
reason_note |
String |
No |
Additional context or details about the reason for terminating user-based products. Personally identifiable information, such as an email address or phone number, should not be included in the reason_note.
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.
