> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# 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.

{% callout type="note" %}
If data passed to Paddle.js is invalid but doesn't prevent Paddle from opening a checkout, a `checkout.warning` event is emitted instead.
{% /callout %}
## Schema

```yaml
title: Checkout error
type: object
properties:
  name:
    type: string
    description: Name of this event, in the format `entity.event_type`.
  type:
    type: string
    description: Type of error which occured.
    enum:
      - front-end_error
      - api_error
    x-enum-descriptions:
      front-end_error:
        description: Typically means there's a problem with Paddle.js or your integration.
      api_error:
        description: Typically means there's a problem with the Paddle API.
  code:
    type: string
    description: Short snake case string that describes this error. Use to search the error reference.
  detail:
    type: string
    description: Some information about what went wrong as a human-readable string.
  documentation_url:
    type: string
    description: Link to a page in the error reference for this specific error.
```

## Example

```json
{
  "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"
}
```