---
title: archive-ai-gateway-budget
product: vercel
url: /docs/rest-api/ai-gateway/archive-ai-gateway-budget
canonical_url: "https://vercel.com/docs/rest-api/ai-gateway/archive-ai-gateway-budget"
last_updated: 2026-09-30
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about archive-ai-gateway-budget on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Archive AI Gateway budget

```http
DELETE /ai-gateway/budgets
```

Archive a team-, project-, or user-scope AI Gateway budget.

## Authentication

**bearerToken**: HTTP bearer

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `scopeType` | string. enum: team, project, user | Yes | The budget scope to archive. |
| `projectId` | string | No | Required when scopeType is "project". |
| `userId` | string | No | Required when scopeType is "user". |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/ai-gateway/budgets?scopeType=string&projectId=string&userId=string&teamId=string&slug=string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/ai-gateway/budgets?scopeType=string&projectId=string&userId=string&teamId=string&slug=string', {
    method: 'DELETE',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X DELETE 'https://api.vercel.com/ai-gateway/budgets?scopeType=string&projectId=string&userId=string&teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

## Example response

```json
{
  "active": "false",
  "alertThresholds": [],
  "archived": "false",
  "createdAt": "123",
  "currentByokSpend": "123",
  "currentSpend": "123",
  "includeByokInQuota": "false",
  "limitAmount": "123",
  "name": "Example Name",
  "quotaEntityId": "example_id",
  "refreshPeriod": "daily",
  "scopeId": "example_id",
  "scopeType": "api-key",
  "source": "default",
  "updatedAt": "123"
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "active",
    "archived",
    "createdAt",
    "currentByokSpend",
    "currentSpend",
    "includeByokInQuota",
    "limitAmount",
    "quotaEntityId",
    "refreshPeriod",
    "scopeId",
    "scopeType",
    "updatedAt"
  ],
  "properties": {
    "active": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "alertThresholds": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "archived": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "createdAt": {
      "type": "number"
    },
    "currentByokSpend": {
      "type": "number"
    },
    "currentSpend": {
      "type": "number"
    },
    "includeByokInQuota": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "limitAmount": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "quotaEntityId": {
      "type": "string"
    },
    "refreshPeriod": {
      "type": "string",
      "enum": [
        "daily",
        "monthly",
        "none",
        "weekly"
      ]
    },
    "scopeId": {
      "type": "string",
      "description": "The native Vercel id of the scoped entity. Team/project ids already carry their prefix, so this equals `quotaEntityId` (`team_…` / `prj_…`); for the api-key scope it is the api key id (the `api_key_id_` prefix stripped)."
    },
    "scopeType": {
      "type": "string",
      "enum": [
        "api-key",
        "project",
        "team",
        "user"
      ]
    },
    "source": {
      "type": "string",
      "description": "Set when the row is inherited from the team's budget default.",
      "enum": [
        "default"
      ]
    },
    "updatedAt": {
      "type": "number"
    }
  }
}
```

### 400: One of the provided values in the request query is invalid.

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: No description

### 410: No description

### 500: No description

---

## Related

- [ai-gateway endpoints](/docs/rest-api#ai-gateway)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://vercel.com/openapi.json) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)