---
# @generated by sylphx-gen 0.1.0 from contracts@190f1b33b937c1aef79697684018db853389b521c75e19ff69ac6af609e96f45. Do not edit.
title: "Get a credit grant"
description: "`money.credit_grants.get` (GET /v1/{name}): Gets a credit grant."
type: reference
product: credits
summary: "Gets a credit grant."
updated: 2026-09-28
nav: false
---

Gets a credit grant.

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

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the credit grant to get. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/credit_grants/{credit_grant}`. |
| `uid` | `string` | `cgrt_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `subject` | `Subject` | Who receives it. Required. |
| `kind` | `string` | `amount` (a total) or `monthly_cap` (up to the amount in each month). Required. |
| `amount_minor` | `string` | Minor units, a decimal string. Required. |
| `start_time` | `timestamp` | When it starts applying. Required. |
| `expire_time` | `timestamp` | When it stops applying; required. Not renewing is how charging starts. Required. |
| `approver` | `string` | Who approved it. Required. |
| `reason` | `string` | Why. Required. |
| `supersedes` | `string` | The grant this one replaces. |
| `tax_treatment` | `string` | `undecided`, `price_reduction`, or `post_tax_settlement`; no default. `post_tax_settlement` is refused while the merchant has automatic tax on. Required. |
| `collection_mode` | `string` | `standard` or `hold`; no default. Over the credit, a held invoice stays due but is not collected until an explicit audited release. Required. |

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

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/credit_grants/credit-grant" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.money.creditGrants.get({ name: 'orgs/acme/projects/shop/envs/production/credit_grants/credit-grant' })
```

**Rust**

```rust
let mut req = sylphx::money::GetCreditGrantRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/credit_grants/credit-grant".to_string();
let response = sx.money().credit_grants().get(req).await?;
```

**CLI**

```bash
sylphx money credit-grants get orgs/acme/projects/shop/envs/production/credit_grants/credit-grant
```

**MCP**

```json
{ "method_id": "money.credit_grants.get", "args": {"name":"orgs/acme/projects/shop/envs/production/credit_grants/credit-grant"} }
```