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
Paddle Docs home

Get checkout recovery settings

Returns the checkout recovery settings for your account.

GET/settings/checkout-recovery

Returns the checkout recovery settings for your account.

These control whether Paddle emails customers who abandon a checkout, and the discount that the email offers.

Requires checkout_settings.read permission.

Response (200)

dataobjectrequired
Represents the checkout recovery settings for your account.
enabledbooleanrequired
Whether Paddle emails customers who abandon a checkout.
discountobject | nullrequired
Discount offered in the recovery email, or null when no discount is offered.
typestringrequired
Kind of discount. percentage is the only kind.
Values
  • percentage
    Discount is a percentage of the transaction total.
amountstringrequired
Example: 10

Percentage taken off the transaction total, as a string containing a whole number from 1 to 100.

"10" means 10%.

Pattern: ^(100|[1-9][0-9]?)$
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Response
{
"data": {
"enabled": true,
"discount": {
"type": "percentage",
"amount": "10"
}
},
"meta": {
"request_id": "d1a2f3b4-5c6d-4e7f-8a9b-0c1d2e3f4a5b"
}
}

Was this page helpful?