---
title: "SDK: budgets"
description: "The budgets methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: budgets

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `budgets` area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## budgetsCheck

Ask whether a spend may go ahead; a refusal stores a stop record

- Request: `POST` on `/v1/tenants/{tenantId}/budgets/check`

```ts
budgetsCheck(args: { tenantId: string; body: BudgetCheckRequest }, options?: CallOptions): Promise<BudgetDecision>
```

## budgetsDelete

Remove a budget limit

- Request: `DELETE` on `/v1/tenants/{tenantId}/budgets`
- Needs an approval for agents: class `spend`

```ts
budgetsDelete(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## budgetsGet

The team's run budgets and what is spent

- Request: `GET` on `/v1/tenants/{tenantId}/budgets`

```ts
budgetsGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## budgetsPut

Set a budget limit (spend class when it raises a limit)

- Request: `PUT` on `/v1/tenants/{tenantId}/budgets`

```ts
budgetsPut(args: { tenantId: string; body: PutBudgetRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## budgetsSpend

Record spend against the budgets

- Request: `POST` on `/v1/tenants/{tenantId}/budgets/spend`

```ts
budgetsSpend(args: { tenantId: string; body: RecordSpendRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## budgetsStops

Stop records written when a budget refused a call

- Request: `GET` on `/v1/tenants/{tenantId}/budgets/stops`

```ts
budgetsStops(args: { tenantId: string }, options?: CallOptions): Promise<BudgetStopList>
```

Source: https://docs.overlane.app/sdk/budgets/index.mdx