> For the complete documentation index, see [llms.txt](https://k4k3ru.gitbook.io/k4k3ru-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://k4k3ru.gitbook.io/k4k3ru-docs/api/crm/get-product.md).

# Get a Credit Product

Get an active K4K3RU credit product by its stable product name. Products reserved for internal system use are not available through this method.

## Endpoint

| Property       | Value                     |
| -------------- | ------------------------- |
| URL            | `https://api.k4k3ru.com/` |
| HTTP method    | `POST`                    |
| RPC method     | `AccountApp.GetProduct`   |
| Authentication | Not required              |

## Request

### Request Body

This method uses the common [JSON-RPC request envelope](/k4k3ru-docs/api/json-rpc.md#request-envelope). Set `method` to `AccountApp.GetProduct`.

### Params Fields

| Field  | Type   | Required | Description                                                                                                     |
| ------ | ------ | -------- | --------------------------------------------------------------------------------------------------------------- |
| `name` | string | Yes      | Stable product name. The value must contain non-whitespace characters and cannot exceed 128 Unicode characters. |

You can obtain available product names from [`AccountApp.ListProducts`](/k4k3ru-docs/api/crm/list-products.md).

### Example Request

```bash
curl --request POST 'https://api.k4k3ru.com/' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "1",
    "method": "AccountApp.GetProduct",
    "params": {
      "name": "usdc-base-mainnet-1"
    }
  }'
```

## Response

### Response Body

Successful requests use the common [JSON-RPC success response envelope](/k4k3ru-docs/api/json-rpc.md#success-response-envelope). Failed requests use the common [JSON-RPC error response envelope](/k4k3ru-docs/api/json-rpc.md#error-response-envelope).

Only active, client-visible products can be returned. An inactive, internal system, or unknown product produces a `not_found` error.

### Result Fields

| Field           | Type           | Description                                                                                                    |
| --------------- | -------------- | -------------------------------------------------------------------------------------------------------------- |
| `id`            | string         | Unique product identifier.                                                                                     |
| `name`          | string         | Stable product name.                                                                                           |
| `type`          | number         | Product type. Current client-visible values are `1` for general, `2` for campaign, and `3` for trial.          |
| `creditTicks`   | string         | Total credit ticks granted by the product, including purchase incentives.                                      |
| `priceAmount`   | string         | Price expressed in whole units of `priceCurrency`.                                                             |
| `priceCurrency` | string         | Fiat currency used to express the price, such as `usd`.                                                        |
| `expiresInDays` | number         | Number of days before the granted credit expires. `0` indicates that no duration is configured by the product. |
| `purchaseLimit` | number         | Product purchase limit. `0` indicates that the product does not define a purchase limit.                       |
| `description`   | string or null | Human-readable product description.                                                                            |
| `metaData`      | object or null | Additional product-specific information.                                                                       |

### Errors

| Code                | When it occurs                                                                                                       |
| ------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `invalid_parameter` | The `params` member cannot be decoded, `name` is empty or whitespace-only, or `name` exceeds 128 Unicode characters. |
| `not_found`         | No active, client-visible product has the requested name.                                                            |
| `unexpected`        | The product cannot be retrieved or encoded because of an unexpected processing or storage failure.                   |

### Example Success Response

```json
{
  "id": "1",
  "result": {
    "id": "1004",
    "name": "usdc-base-mainnet-1",
    "type": 2,
    "creditTicks": "1000000",
    "priceAmount": "1",
    "priceCurrency": "usd",
    "expiresInDays": 30,
    "purchaseLimit": 0,
    "description": "1 USDC credit on Base Mainnet",
    "metaData": {
      "Chain": "base",
      "Network": "mainnet",
      "Token": "USDC"
    }
  }
}
```

Product values shown above are examples. Use the values returned by the API.

### Example Error Response

```json
{
  "id": "1",
  "error": {
    "code": "not_found"
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://k4k3ru.gitbook.io/k4k3ru-docs/api/crm/get-product.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.