Errors
When a request fails, Paddle returns an error object with an appropriate HTTP response code. Errors are consistent and include information to help troubleshoot.
The Paddle API uses standard HTTP response codes to let you know when something's wrong. It also returns some useful information to help you troubleshoot.
For a comprehensive overview of all the errors you might encounter when working with the Paddle API, check out our error reference. Each error includes common causes and information on how to fix.
HTTP status codes
Errors generally return a 4xx response code.
Though rare, you may get a 5xx response code. This means that there's a problem with the Paddle API rather than your code. Try your request later, or check our status page.
Success responses return a
2xxstatus code.
Error object
When you encounter an error, the API returns an error object rather than a data object or array.
Type of error encountered.
Short snake case string that describes this error. Use to search the error reference.
Some information about what went wrong as a human-readable string.
Link to a page in the error reference for this specific error.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
For example:
12345678910111{
2 "error": {
3 "type": "request_error",
4 "code": "not_found",
5 "detail": "Entity pro_01gsz97mq9pa4fkyy0wqenepkz not found",
6 "documentation_url": "https://developer.paddle.com/errors/shared/not_found"
7 },
8 "meta": {
9 "request_id": "9346b365-4cad-43a6-b7c1-48ff6a1c7836"
10 }
11}Validation error object
When making requests, all fields are checked against the API reference to make sure they're valid. If a value for a field fails validation, Paddle includes an array of errors to let you know which fields need your attention.
Type of error encountered.
Short snake case string that describes this error. Use to search the error reference.
Some information about what went wrong as a human-readable string.
Link to a page in the error reference for this specific error.
List of validation errors.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
For example:
12345678910111213141516171819201{
2 "error": {
3 "type": "request_error",
4 "code": "product_invalid_field",
5 "detail": "Invalid values for fields in request",
6 "documentation_url": "https://developer.paddle.com/errors/product/product_invalid_field",
7 "errors": [
8 {
9 "field": "name",
10 "message": "max length of 200 exceeded, provided value length 220"
11 },
12 {
13 "field": "image_url",
14 "message": "must be a valid image"
15 }
16 ]
17 },
18 "meta": {
19 "request_id": "9346b365-4cad-43a6-b7c1-48ff6a1c7836"
20 }
