# Read Plaid readiness

Whether a bank can be linked on this workspace right now, on whose Plaid keys (its end customer's under Specter's partner account, the keys it typed, or Specter's own for merchant-facing links), and on what terms: free during the trial, counted against the bank login package (included logins used, overage so far, when the period ends), blocked once the trial has ended without the package, or not counted at all on the workspace's own Plaid account. Calls nobody. Admin only.

Access class: `workspace:admin`.

## Endpoint

`GET /v1/integrations/plaid/readiness`

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "billing": {
      "access": "string",
      "cancelAtPeriodEnd": true,
      "currency": "string",
      "includedBankLogins": 1.5,
      "overageCount": 1.5,
      "overageMinor": 1.5,
      "overageTotalMinor": 1.5,
      "status": "string",
      "subscribed": true,
      "used": 1.5
    },
    "ownKeys": true,
    "partnerAvailable": true,
    "partnerEnvironment": "string",
    "ready": true,
    "reason": "string",
    "source": "string"
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```
