Properties
| Name | Type | Description |
|---|---|---|
| status_code | number | HTTP status code |
| error | string | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) |
| type_name | string | The type of error returned |
| message | string | A human-readable message providing more details about the error. |
| detail | string | Contains parameter or domain specific information related to the error and why it occurred. |
| ref | string | Link to documentation of error type |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PaymentRequiredResponse",
"title": "PaymentRequiredResponse",
"type": "object",
"x-apideck-schema-id": "PaymentRequired",
"properties": {
"status_code": {
"type": "number",
"description": "HTTP status code",
"example": 402
},
"error": {
"type": "string",
"description": "Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)",
"example": "Payment Required"
},
"type_name": {
"type": "string",
"description": "The type of error returned",
"example": "RequestLimitError"
},
"message": {
"type": "string",
"description": "A human-readable message providing more details about the error.",
"example": "Request Limit Reached",
"x-speakeasy-error-message": true
},
"detail": {
"type": "string",
"description": "Contains parameter or domain specific information related to the error and why it occurred.",
"example": "You have reached your limit of 2000"
},
"ref": {
"type": "string",
"description": "Link to documentation of error type",
"example": "https://developers.apideck.com/errors#requestlimiterror"
}
}
}