Sha256: b2ebcc31b4228933e425f97949c46a370aefc403f30b45d843d23757ea8b2b13

Contents?: true

Size: 1.97 KB

Versions: 2

Compression:

Stored size: 1.97 KB

Contents

# Plaid::Item

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **item_id** | **String** | The Plaid Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive. |  |
| **institution_id** | **String** | The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits. | [optional] |
| **webhook** | **String** | The URL registered to receive webhooks for the Item. | [optional] |
| **error** | [**Error**](Error.md) |  | [optional] |
| **available_products** | [**Array<Products>**](Products.md) | A list of products available for the Item that have not yet been accessed. |  |
| **billed_products** | [**Array<Products>**](Products.md) | A list of products that have been billed for the Item. Note - `billed_products` is populated in all environments but only requests in Production are billed.  |  |
| **consent_expiration_time** | **String** | The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the `ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.  Note - This is only relevant for European institutions subject to PSD2 regulations mandating a 90-day consent window. For all other institutions, this field will be null.  | [optional] |
| **update_type** | **String** |  | [optional] |

## Example

```ruby
require 'plaid'

instance = Plaid::Item.new(
  item_id: null,
  institution_id: null,
  webhook: null,
  error: null,
  available_products: null,
  billed_products: null,
  consent_expiration_time: null,
  update_type: null
)
```

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
plaid-14.0.0.beta.2 docs/Item.md
plaid-14.0.0.beta.1 docs/Item.md