Errors

The API uses conventional HTTP status codes: 2xx means success, 4xx means something is wrong with the request and 5xx means something went wrong on our side.

Error responses

Errors come as JSON with the status code repeated and a human readable message:

{
    "status": 404,
    "error": "Customer not found"
}

When the request body does not validate, the response is a 422 with the offending fields and their messages under fields:

{
    "status": 422,
    "error": "Could not create customer. Some fields contain invalid data",
    "fields": {
        "email": ["The email field is required."]
    }
}

Status codes