---
# @generated by sylphx-gen. Do not edit.
title: "Snapshot an entitlement grant"
description: "`money.entitlement_grants.snapshot` (GET /v1/{parent}/entitlement_grants:snapshot): Reads a coherent entitlement snapshot with an environment-wide source revision."
type: reference
product: payments
summary: "Reads a coherent entitlement snapshot with an environment-wide source revision."
updated: 2026-09-28
nav: false
---

Reads a coherent entitlement snapshot with an environment-wide source revision. Discard every page and restart after ETAG_MISMATCH.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:snapshot`
- **Scope** `billing:read`
- **Effect** `read` — nothing is written.
- **Collection** [entitlement_grants](/docs/api/entitlement_grants)
- **Query** `page_size`, `page_token`, `filter`, `snapshot_revision`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment whose entitlement collection is read. Required. |
| `page_size` | `int32` | At most this many; default 50, clamped to 1000. |
| `page_token` | `string` | `next_page_token` of the previous page of this snapshot. |
| `filter` | `string` | AIP-160 filter over entitlement grant fields. |
| `snapshot_revision` | `string` | Expected environment-wide collection revision, as a canonical decimal string. Empty selects the current source snapshot; any nonempty value, including "0", requires equality or returns HTTP 409 ETAG_MISMATCH. Send the first response's revision on every subsequent page. Page tokens also fence that revision and cannot be reused after a collection change. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `entitlement_grants` | `EntitlementGrant[]` | The page. |
| `next_page_token` | `string` | The token of the next page; empty on the last page. |
| `snapshot_revision` | `string` | Always present as a canonical decimal string, including "0" for a source with no committed grant mutations. Versions all grants in the environment, regardless of filter, including deletion of the last grant. Not a clock or resource etag. Rows and revision are read in one database snapshot. Output only. |

### EntitlementGrant

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/entitlement_grants/{entitlement_grant}`. |
| `uid` | `string` | `egr_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `Subject` | Who holds it. |
| `feature` | `string` | The feature key. |
| `limit` | `string` | For a `limit` feature, the allowance as a decimal string. Output only. |
| `source` | `string` | The resource that grants it, for example a customer subscription's name. Output only. |
| `expire_time` | `timestamp` | When it ends; unset for no end. |
| `campaign` | `string` | A manual grant's campaign (input on create, up to 64 characters). |
| `reason` | `string` | A manual grant's reason (input on create, up to 500 characters). |
| `approval_ref` | `string` | A free-text reference to the approval, for example `CEO 2026-10-02` (input on create, up to 200 characters). |
| `approver` | `string` | The principal that created a manual grant: the verified key's principal, never a request field. 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.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.

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

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:snapshot" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.money.entitlementGrants.snapshot({ parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::money::SnapshotEntitlementGrantsRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.money().entitlement_grants().snapshot(req).await?;
```

**CLI**

```bash
sylphx money entitlement-grants snapshot orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "money.entitlement_grants.snapshot", "args": {"parent":"orgs/acme/projects/shop/envs/production"} }
```