POST /item/products/terminate

The /item/products/terminate endpoint allows you to terminate an Item. Once terminated, the access_token associated with the Item is no longer valid, billing for the Item's products is ended, and relevant webhooks are fired.

/item/products/terminate is the recommended way to offboard users or disconnect accounts linked via Plaid.

Servers

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 on the Item.

OTHER: Any other reason for terminating products not covered by the above categories

Valid values:

  • "OTHER"
access_token String Yes

The access token associated with the Item data is being requested for.

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.

reason_note String No

Additional context or details about the reason for terminating products on the Item. Personally identifiable information, such as an email address or phone number, should not be included in the reason_note.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.