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.payment.error

Emitted when a payment errors for a checkout.

Use checkout.payment.error to run actions when a payment errors for a checkout.

This typically occurs when no payment methods are available. For example, if you open a checkout with allowedPaymentMethods set to ["apple-pay"], but the customer's device or browser doesn't support Apple Pay, this is emitted.

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.payment.error",
  "type": "front-end_error",
  "code": "no_payment_methods_available",
  "detail": "No payment methods available",
  "documentation_url": "https://developer.paddle.com/api-reference/overview"
}

Was this page helpful?