---
# @generated by sylphx-gen 0.1.0 from contracts@190f1b33b937c1aef79697684018db853389b521c75e19ff69ac6af609e96f45. Do not edit.
title: "Settle an usage reservation"
description: "`money.usage_reservations.settle` (POST /v1/{name}:settle): Settles a reservation with what was used; the unused part returns to headroom."
type: reference
product: payments
summary: "Settles a reservation with what was used; the unused part returns to headroom."
updated: 2026-09-28
nav: false
---

Settles a reservation with what was used; the unused part returns to headroom. A settle after expiry still records the usage.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation:settle`
- **Scope** `billing:metering:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [usage_reservations](/docs/api/usage_reservations)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The reservation to settle. Required. |
| `quantity_used` | `int64` | What was used, in the meter's base unit; 0 to the granted quantity, or more after expiry (the work happened). Required. |
| `occurred_time` | `timestamp` | When the work happened; now when absent. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/usage_events/{usage_event}`. |
| `uid` | `string` | `uevt_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `Subject` | Who used it. Required. |
| `subject_proof` | `string` | As on UsageReservation. Required. |
| `actor_proof` | `string` | As on UsageReservation. |
| `meter` | `string` | The meter's lookup key. Required. |
| `quantity` | `int64` | How much, in the meter's base unit. Required. |
| `occurred_time` | `timestamp` | When the work happened. Required. |
| `amount_nano` | `string` | The rated amount, nano-minor, a decimal string. Output only. |
| `usage_reservation` | `string` | The reservation it settled, when it did. Output only. |
| `late` | `bool` | Settled after the reservation expired; the usage is still recorded. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### Subject

| Field | Type | What it is |
| --- | --- | --- |
| `end_user` | `string` | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the `kind` group. |
| `customer_organization` | `string` | A customer organization's id. One of the `kind` group. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation:settle" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quantity_used":1}'
```

**TypeScript**

```ts
const response = await sylphx.money.usageReservations.settle({ name: 'orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation', quantityUsed: 1 })
```

**Rust**

```rust
let mut req = sylphx::money::SettleUsageReservationRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation".to_string();
req.quantity_used = 1;
let response = sx.money().usage_reservations().settle(req).await?;
```

**CLI**

```bash
sylphx money usage-reservations settle orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation
```

**MCP**

```json
{ "method_id": "money.usage_reservations.settle", "args": {"name":"orgs/acme/projects/shop/envs/production/usage_reservations/usage-reservation","quantity_used":1} }
```