# ClerkAPIError

An interface that represents an error returned by the Clerk API.

| Name                                          | Type                                   | Description                                                              |
| --------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------ |
| code                                          | string                                 | A string code that represents the error, such as username\_exists\_code. |
| message                                       | string                                 | A message that describes the error.                                      |
| longMessage?                                  | string                                 | A more detailed message that describes the error.                        |
| meta?                                         | object                                 | Additional information about the error.                                  |
| meta.paramName?                               | string                                 | The name of the parameter that caused the error.                         |
| meta.sessionId?                               | string                                 | The ID of the session that caused the error.                             |
| meta.emailAddresses?                          | string[]                              | The email addresses that caused the error.                               |
| meta.identifiers?                             | string[]                              | The identifiers that caused the error.                                   |
| meta.zxcvbn?                                  | object                                 | The zxcvbn score of the password that caused the error.                  |
| meta.zxcvbn.suggestions?                      | { code: string; message: string; }[] | Suggestions to improve the password.                                     |
| meta.permissions?                             | string[]                              | The permissions that caused the error.                                   |
| meta.plan?                                    | object                                 | The plan that caused the error.                                          |
| meta.plan.id?                                 | string                                 | The ID of the plan that caused the error.                                |
| meta.plan.name?                               | string                                 | The name of the plan.                                                    |
| meta.plan.amount\_formatted?                  | string                                 | The formatted amount of the plan.                                        |
| meta.plan.annual\_monthly\_amount\_formatted? | string                                 | The formatted annual or monthly amount of the plan.                      |
| meta.plan.currency\_symbol?                   | string                                 | The currency symbol of the plan.                                         |
| meta.isPlanUpgradePossible?                   | boolean                                | Whether the plan upgrade is possible.                                    |

---

## Sitemap

[Overview of all docs pages](https://clerk.com/docs/llms.txt)