> 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/list-products.md).

# List Credit Products

List the active K4K3RU credit products currently available for selection. The response is paginated and excludes products reserved for internal system use.

## Endpoint

| Property       | Value                     |
| -------------- | ------------------------- |
| URL            | `https://api.k4k3ru.com/` |
| HTTP method    | `POST`                    |
| RPC method     | `AccountApp.ListProducts` |
| 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.ListProducts`.

The `params` member may be omitted or set to `null` when requesting the first page.

### Params Fields

| Field  | Type   | Required | Description                                                                                                |
| ------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------- |
| `page` | number | No       | One-based page number. Omit this field or use `0` to request page 1. Each page contains up to 20 products. |

The page size is fixed by the service and cannot be specified by the client.

### Example Request

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

The following request also returns page 1:

```json
{
  "id": "1",
  "method": "AccountApp.ListProducts",
  "params": null
}
```

## 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 are included. Internal system products, including the sign-up bonus product, are excluded.

The current credit products use the following fixed purchase tiers:

| Payment token | Payment amounts   | Credit ticks                             | Supported networks                                                                            |
| ------------- | ----------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------- |
| USDC          | `1`, `10`, `100`  | `1,000,000`, `12,500,000`, `150,000,000` | Base Mainnet, Base Sepolia, Ethereum Mainnet, Ethereum Sepolia, Polygon Mainnet, Polygon Amoy |
| JPYC          | `1,000`, `10,000` | `12,500,000`, `150,000,000`              | Polygon Mainnet, Polygon Amoy                                                                 |

The middle USDC tier and the 1,000 JPYC tier grant 25% more credit than the base rate. The largest tiers grant 50% more. JPYC currently uses a fixed conversion based on 100 JPYC to 1,000,000 credit ticks before applying these bonuses, but the 100 JPYC tier is not offered because its transfer amount is too small for payment settlement. Sepolia and Amoy products are test-network products and are not production settlement options.

### Result Fields

| Field                      | Type           | Description                                                                                                    |
| -------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------- |
| `products`                 | array          | Products on the requested page, ordered by product ID in ascending order.                                      |
| `products[].id`            | string         | Unique product identifier.                                                                                     |
| `products[].name`          | string         | Stable product name.                                                                                           |
| `products[].type`          | number         | Product type. Current client-visible values are `1` for general, `2` for campaign, and `3` for trial.          |
| `products[].creditTicks`   | string         | Total credit ticks granted by the product, including purchase incentives.                                      |
| `products[].priceAmount`   | string         | Price expressed in whole units of `priceCurrency`.                                                             |
| `products[].priceCurrency` | string         | Fiat currency used to express the price, such as `usd`.                                                        |
| `products[].expiresInDays` | number         | Number of days before the granted credit expires. `0` indicates that no duration is configured by the product. |
| `products[].purchaseLimit` | number         | Product purchase limit. `0` indicates that the product does not define a purchase limit.                       |
| `products[].description`   | string or null | Human-readable product description.                                                                            |
| `products[].metaData`      | object or null | Additional product-specific information.                                                                       |
| `page`                     | number         | One-based page number returned by the service.                                                                 |
| `limit`                    | number         | Maximum products returned per page. This value is currently `20`.                                              |
| `total`                    | number         | Total number of active, client-visible products.                                                               |
| `totalPages`               | number         | Total number of pages available at the current limit.                                                          |

### Errors

| Code                | When it occurs                                                                                                             |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `invalid_parameter` | The `params` member cannot be decoded, `page` has an incompatible type, or the page number is outside the supported range. |
| `unexpected`        | The product list cannot be retrieved or encoded because of an unexpected processing or storage failure.                    |

### Example Success Response

```json
{
  "id": "1",
  "result": {
    "products": [
      {
        "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"
        }
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 6,
    "totalPages": 1
  }
}
```

The products and pagination values shown above are examples. Use the values returned by the API.

### Example Error Response

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


---

# 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/list-products.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.
