The Suscription API uses standard HTTP response codes to indicate the success or failure of API requests.
| Status Code | Description |
|---|---|
| 200 | Success - The request was successful |
| 400 | Bad Request - The request was malformed or invalid |
| 401 | Unauthorized - Authentication credentials are missing or invalid |
| 403 | Forbidden - The authenticated user does not have access to this resource |
| 404 | Not Found - The requested address could not be found |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - An unexpected error occurred |
| 503 | Service Unavailable - The service is temporarily unavailable |
Error responses will include a JSON body with additional details:
| Field | Type | Description |
|---|---|---|
| errorType | string | Stable error code that can be used to decide how to handle an error |
| errorMessage | string | Human-readable description of the error |
{
"errorType": "INVALID_INPUT",
"errorMessage": "response - value is not a valid dict"
}{
"errorType": "UNAUTHORIZED",
"errorMessage": "Unauthorized"
}{
"errorType": "RECORD_NOT_FOUND",
"errorMessage": "Subscription record not found"
}{
"errorType": "INTERNAL_SERVER_ERROR",
"errorMessage": "The system has encountered an unexpected error, please try again later."
}