---
title: "List all credit products"
method: GET
path: "/v1/customers/credits"
tags: ["Customers > Credits"]
---

# List all credit products

`GET /v1/customers/credits`

Retrieve credit products for all customers.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `product_id` string
- `product_id__not` string
- `product_id__isNull` string
- `product_id__isNotNull` string
- `product_id__equals` string
- `product_id__contains` string
- `product_id__startsWith` string
- `product_id__endWith` string
- `customer_id` string
- `customer_id__not` string
- `customer_id__isNull` string
- `customer_id__isNotNull` string
- `customer_id__equals` string
- `customer_id__contains` string
- `customer_id__startsWith` string
- `customer_id__endWith` string
- `updated_at` string, date-time
- `updated_at__not` string, date-time
- `updated_at__isNull` string, date-time
- `updated_at__isNotNull` string, date-time
- `updated_at__equals` string, date-time
- `updated_at__lt` string, date-time
- `updated_at__lte` string, date-time
- `updated_at__gt` string, date-time
- `updated_at__gte` string, date-time

## Response `200`

- PaginatedCredit
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` Credit[], required — List of Credit.
    - `product_id` string, required — Credit product ID.
    - `customer_id` string, required — Customer ID related to the credit.
    - `name` string, required — Credit name.
    - `current_balance` number, required — Current credit balance.
    - `low_count_threshold` number, nullable, required — Value indicating a low threshold.
    - `last_refreshed_at` string, date-time, required — Credit last refresh date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    - `auto_topup` object, nullable, required — Auto top-up options.
      - `credit_count` number, required — Value indicating a number of credits to add. If `price_id` is defined, this value must correspond to a full credit pack for the price.
      - `amount_excluding_tax` number, nullable, required — Custom amount for the added credits. Either `amount_excluding_tax` or `price_id` must be defined. Expressed in currency's smallest unit.
      - `price_id` string, nullable, required — Price ID used to add credits. The price must be of type `bundle`. Either `amount_excluding_tax` or `price_id` must be defined.
    - `created_at` string, date-time, required — Credit creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    - `updated_at` string, date-time, required — Credit last edition date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

---

[API](https://skmtc.net/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.net/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/versions/19fa5f22e39b/schema)