codex/codex-rs/app-server-protocol/schema/json/v2/GetAccountRateLimitsResponse.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "CreditsSnapshot": {
      "properties": {
        "balance": {
          "type": [
            "string",
            "null"
          ]
        },
        "hasCredits": {
          "type": "boolean"
        },
        "unlimited": {
          "type": "boolean"
        }
      },
      "required": [
        "hasCredits",
        "unlimited"
      ],
      "type": "object"
    },
    "PlanType": {
      "enum": [
        "free",
        "go",
        "plus",
        "pro",
        "prolite",
        "team",
        "self_serve_business_usage_based",
        "business",
        "enterprise_cbp_usage_based",
        "enterprise",
        "edu",
        "unknown"
      ],
      "type": "string"
    },
    "RateLimitReachedType": {
      "enum": [
        "rate_limit_reached",
        "workspace_owner_credits_depleted",
        "workspace_member_credits_depleted",
        "workspace_owner_usage_limit_reached",
        "workspace_member_usage_limit_reached"
      ],
      "type": "string"
    },
    "RateLimitResetCredit": {
      "properties": {
        "description": {
          "description": "Backend-provided display description for this credit, or `null` when unavailable.",
          "type": [
            "string",
            "null"
          ]
        },
        "expiresAt": {
          "description": "Unix timestamp in seconds when the credit expires, or `null` if it does not expire.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "grantedAt": {
          "description": "Unix timestamp in seconds when the credit was granted.",
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "description": "Opaque backend identifier for this reset credit.",
          "type": "string"
        },
        "resetType": {
          "$ref": "#/definitions/RateLimitResetType"
        },
        "status": {
          "$ref": "#/definitions/RateLimitResetCreditStatus"
        },
        "title": {
          "description": "Backend-provided display title for this credit, or `null` when unavailable.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "grantedAt",
        "id",
        "resetType",
        "status"
      ],
      "type": "object"
    },
    "RateLimitResetCreditStatus": {
      "enum": [
        "available",
        "redeeming",
        "redeemed",
        "unknown"
      ],
      "type": "string"
    },
    "RateLimitResetCreditsSummary": {
      "properties": {
        "availableCount": {
          "format": "int64",
          "type": "integer"
        },
        "credits": {
          "description": "Detail rows for available reset credits, when the backend provides them.\n\n`null` means only `availableCount` is known, while an empty array means details were fetched and no available credits were returned. The backend may cap this list, so its length can be less than `availableCount`.",
          "items": {
            "$ref": "#/definitions/RateLimitResetCredit"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "required": [
        "availableCount"
      ],
      "type": "object"
    },
    "RateLimitResetType": {
      "enum": [
        "codexRateLimits",
        "unknown"
      ],
      "type": "string"
    },
    "RateLimitSnapshot": {
      "properties": {
        "credits": {
          "anyOf": [
            {
              "$ref": "#/definitions/CreditsSnapshot"
            },
            {
              "type": "null"
            }
          ]
        },
        "individualLimit": {
          "anyOf": [
            {
              "$ref": "#/definitions/SpendControlLimitSnapshot"
            },
            {
              "type": "null"
            }
          ]
        },
        "limitId": {
          "type": [
            "string",
            "null"
          ]
        },
        "limitName": {
          "type": [
            "string",
            "null"
          ]
        },
        "planType": {
          "anyOf": [
            {
              "$ref": "#/definitions/PlanType"
            },
            {
              "type": "null"
            }
          ]
        },
        "primary": {
          "anyOf": [
            {
              "$ref": "#/definitions/RateLimitWindow"
            },
            {
              "type": "null"
            }
          ]
        },
        "rateLimitReachedType": {
          "anyOf": [
            {
              "$ref": "#/definitions/RateLimitReachedType"
            },
            {
              "type": "null"
            }
          ]
        },
        "secondary": {
          "anyOf": [
            {
              "$ref": "#/definitions/RateLimitWindow"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "RateLimitWindow": {
      "properties": {
        "resetsAt": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "usedPercent": {
          "format": "int32",
          "type": "integer"
        },
        "windowDurationMins": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "usedPercent"
      ],
      "type": "object"
    },
    "SpendControlLimitSnapshot": {
      "properties": {
        "limit": {
          "type": "string"
        },
        "remainingPercent": {
          "format": "int32",
          "type": "integer"
        },
        "resetsAt": {
          "format": "int64",
          "type": "integer"
        },
        "used": {
          "type": "string"
        }
      },
      "required": [
        "limit",
        "remainingPercent",
        "resetsAt",
        "used"
      ],
      "type": "object"
    }
  },
  "properties": {
    "rateLimitResetCredits": {
      "anyOf": [
        {
          "$ref": "#/definitions/RateLimitResetCreditsSummary"
        },
        {
          "type": "null"
        }
      ]
    },
    "rateLimits": {
      "allOf": [
        {
          "$ref": "#/definitions/RateLimitSnapshot"
        }
      ],
      "description": "Backward-compatible single-bucket view; mirrors the historical payload."
    },
    "rateLimitsByLimitId": {
      "additionalProperties": {
        "$ref": "#/definitions/RateLimitSnapshot"
      },
      "description": "Multi-bucket view keyed by metered `limit_id` (for example, `codex`).",
      "type": [
        "object",
        "null"
      ]
    }
  },
  "required": [
    "rateLimits"
  ],
  "title": "GetAccountRateLimitsResponse",
  "type": "object"
}