---
# @generated by sylphx-gen 0.1.0 from contracts@190f1b33b937c1aef79697684018db853389b521c75e19ff69ac6af609e96f45. Do not edit.
title: "Check standing on an usage event"
description: "`money.usage_events.check_standing` (POST /v1/{parent}/usage_events:checkStanding): Reads a subject's standing: active, past due or suspended, whether a payment method is on file, headroom and the threshold."
type: reference
product: payments
summary: "Reads a subject's standing: active, past due or suspended, whether a payment method is on file, headroom and the threshold."
updated: 2026-09-28
nav: false
---

Reads a subject's standing: active, past due or suspended, whether a payment method is on file, headroom and the threshold.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events:checkStanding`
- **Scope** `billing:read`
- **Effect** `read` — nothing is written.
- **Collection** [usage_events](/docs/api/usage_events)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment. Required. |
| `subject` | `Subject` | Whose standing. Required. |
| `subject_proof` | `string` | As on UsageReservation: a verified token for the subject. Required. |
| `actor_proof` | `string` | For a customer organization: the acting user's token. |

### 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. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `state` | `string` | `active`, `past_due`, or `suspended`. |
| `payment_method_on_file` | `bool` | Whether a payment method is on file. |
| `headroom_minor` | `string` | What the subject may still use now, minor units, a decimal string; empty when it has no limit. |
| `threshold_minor` | `string` | The amount that makes a threshold invoice be cut, minor units. |

## 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.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.

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_events:checkStanding" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":{},"subject_proof":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.money.usageEvents.checkStanding({ parent: 'orgs/acme/projects/shop/envs/production', subject: {}, subjectProof: '…' })
```

**Rust**

```rust
let mut req = sylphx::money::CheckUsageStandingRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.subject = Some(Default::default());
req.subject_proof = "…".to_string();
let response = sx.money().usage_events().check_standing(req).await?;
```

**CLI**

```bash
sylphx money usage-events check-standing orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "money.usage_events.check_standing", "args": {"parent":"orgs/acme/projects/shop/envs/production","subject":{},"subject_proof":"…"} }
```