For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

checkout.error

Emitted when an error occurs on a checkout.

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_error
    Typically means there's a problem with Paddle.js or your integration.
  • api_error
    Typically means there's a problem with the Paddle API.
codestring
A short string that identifies the error.
detailstring
A human-readable string describing what went wrong, useful for logging and debugging. The exact wording can change, so don't rely on it in conditional logic.
documentation_urlstring
Link to documentation related to this error.
Example
{
"name": "checkout.error",
"type": "api_error",
"code": "validation",
"detail": "Invalid request.",
"documentation_url": "https://developer.paddle.com/api-reference"
}

Was this page helpful?