ClerkAPIError
An interface that represents an error returned by the Clerk API.
- Name
code- Type
string- Description
A string code that represents the error, such as
username_exists_code.
- Name
message- Type
string- Description
A message that describes the error.
- Name
longMessage?- Type
string- Description
A more detailed message that describes the error.
- Name
meta?- Type
object- Description
Additional information about the error.
- Name
meta.paramName?- Type
string- Description
The name of the parameter that caused the error.
- Name
meta.sessionId?- Type
string- Description
The ID of the session that caused the error.
- Name
meta.emailAddresses?- Type
string[]- Description
The email addresses that caused the error.
- Name
meta.identifiers?- Type
string[]- Description
The identifiers that caused the error.
- Name
meta.zxcvbn?- Type
object- Description
The zxcvbn score of the password that caused the error.
- Name
meta.zxcvbn.suggestions?- Type
{ code: string; message: string; }[]- Description
Suggestions to improve the password.
- Name
meta.permissions?- Type
string[]- Description
The permissions that caused the error.
- Name
meta.plan?- Type
object- Description
The plan that caused the error.
- Name
meta.plan.id?- Type
string- Description
The ID of the plan that caused the error.
- Name
meta.plan.name?- Type
string- Description
The name of the plan.
- Name
meta.plan.amount_formatted?- Type
string- Description
The formatted amount of the plan.
- Name
meta.plan.annual_monthly_amount_formatted?- Type
string- Description
The formatted annual or monthly amount of the plan.
- Name
meta.plan.currency_symbol?- Type
string- Description
The currency symbol of the plan.
- Name
meta.isPlanUpgradePossible?- Type
boolean- Description
Whether the plan upgrade is possible.
Feedback
Last updated on