Use checkout.error to run actions when an error occurs on a checkout. Errors occur when data passed to Paddle.js prevents Paddle from opening a checkout entirely.
For example, if you pass properties to Paddle.js that are fundamentally incompatible, you can use checkout.error to log the error to your analytics tool. You may be able to parse the error to relaunch the checkout with the correct data.
If data passed to Paddle.js is invalid but doesn't prevent Paddle from opening a checkout, a checkout.warning event is emitted instead.
namestring
Name of this event, in the format
entity.event_type.typestring
Type of error which occured.
Values
front-end_errorTypically means there's a problem with Paddle.js or your integration.api_errorTypically means there's a problem with the Paddle API.
codestring
Short snake case string that describes this error. Use to search the error reference.
detailstring
Some information about what went wrong as a human-readable string.
documentation_urlstring
Link to a page in the error reference for this specific error.
{ "name": "checkout.error", "type": "front-end_error", "code": "invalid_email_address", "detail": "The email address supplied isn't valid.", "documentation_url": "https://developer.paddle.com/api-reference/overview"}