Quickstart API Error Handling

Your Zuora integration may have to deal with errors when making requests to the Zuora API.

Zuora uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

• Codes in the 2xx range indicate success.
• Codes in the 4xx range indicate errors that occurred on the user's end, for example, a required parameter was missing, or a resource has been removed.
• Codes in the 5xx range indicate errors with Zuora's servers.

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

An error response contains the following attributes:

HTTP status codes

The following table lists the HTTP status codes you might receiving when working with the Quickstart API:

Error types

The following table lists values of the type field in the error response, and their corresponding description:

Error codes

Some errors include an error code - a short string with a brief explanation.

Below is a list of possible error codes, along with additional information about how to resolve them.

Handling errors

If you use the Zuora SDK, use the following template to handle errors:

try {
  
  // Use Zuora's client library to make requests

} catch (RateLimitException e) {
  // Too many requests made to the API too quickly
} catch (InvalidRequestException e) {
  // Invalid parameters were supplied to Zuora's API
} catch (AuthenticationException e) {
  // Authentication with Zuora's API failed (maybe you changed API keys recently)
} catch (APIConnectionException e) {
  // Network communication with Zuora failed
} catch (ZuoraException e) {
  // Display a very generic error to the user, and maybe send yourself an email
} catch (Exception e) {
  // Something else happened, completely unrelated to Zuora
}

(async () => {
  try {

   // Use Zuora's client library to make requests
    
  }
  catch (error) {
     console.log(error);
  }
})();