Rest API Version: 1.0.0
REST APIs
Status and Error Codes
The API resources returns the below response codes for successful and error cases. The response status codes need be examined before the response body. In most error cases, the response body will contain an errors with more details.
Successful Status Codes (2XX)
- 200 OK
The request was successful.
- 201 Created
The resource was successfully created. Confirms a success when creating a new object.
- 202 Accepted
The request has been accepted for processing, but the processing has not been completed.
- 204 No Content
The request was successful and there is no response body.
Client Error Status Codes (4XX)
- 400 Bad Request
The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error. This commonly occurs when your XML is invalid, e.g. ampersands are not correctly encoded in the text of your request. Please inspect the body of the response for more details regarding the error.
- 401 Unauthorized
Your API key is missing or invalid.
- 402 Payment Required
Your Recurly account is in production mode but is not in good standing. Please pay any outstanding invoices.
- 403 Forbidden
The login is attempting to perform an action it does not have privileges to access. Verify your login credentials are for the appropriate account.
- 404 Not Found
The resource was not found with the given identifier. The response body will explain which resource was not found.
- 405 Method Not Allowed
The requested method is not valid at the given URL.
- 406 Not Acceptable
The request's Accept header is not set to application/json.
- 412 Precondition Failed
The request was unsuccessful because a condition was not met. For example, this message may be returned if you attempt to cancel a subscription for an account that has no subscription.
- 422 Unprocessable Entity
Could not process a POST or PUT request because the request is invalid. See the response body for more details.
- 429 Too many Requests
You have made too many API requests in the last hour. Future API requests will be ignored until the beginning of the next hour.
Server Error Status Codes (5XX)
- 500 Internal Server Error
The server encountered an error while processing your request and failed.
- 502 Gateway Error
The load balancer or web server has trouble connecting to the Recurly app. Please try the request again.
- 503 Service Unavailable
The service is temporarily unavailable. Please try the request again.
Future Compatibility
For future compatibility, please interpret the following status code ranges:
- 200-299 as success
- 400-499 as client request errors
- 500-599 as server errors
Additional Status Codes
- 404 Not Found Responses
- 422 Unprocessable Entity Responses
