---
title: "GET /api/credits/"
method: GET
path: "/api/credits/"
tags: ["api"]
---

# GET /api/credits/

`GET /api/credits/`

## Query parameters

- `currency_code` string
- `customer_id` string, nullable, required
- `effective_after` string, date-time
- `effective_before` string, date-time
- `expires_after` string, date-time
- `expires_before` string, date-time
- `issued_after` string, date-time
- `issued_before` string, date-time
- `status` string[]

## Response `200`

- CustomerBalanceAdjustment[]
  - `credit_id` string, required
  - `customer` LightweightCustomer, required
    - `customer_name` string, nullable, required — The display name of the customer
    - `email` string, email, nullable, required — The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider
    - `customer_id` string, nullable, required — The id provided when creating the customer, we suggest matching with your internal customer id in your backend
  - `amount` number, double, required
  - `amount_remaining` number, double, required
  - `currency` PricingUnit, required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `description` string, nullable, required
  - `effective_at` string, date-time, required
  - `expires_at` string, date-time, nullable, required
  - `status` 'active' | 'inactive', required
  - `amount_paid` number, double, required
  - `amount_paid_currency` PricingUnit, required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `drawdowns` CreditDrawdown[], required
    - `credit_id` string, required
    - `amount` number, double, required
    - `description` string, nullable
    - `applied_at` string, date-time, required

## Changes

- **2023-02-20** `d246ebbb528d` — 2 breaking
  - for the `query` request parameter `status`, default value was changed from `active, inactive` to `inactive, active`
  - the response property `items/customer/customer_id` became nullable for the status `200`
- **2023-02-20** `5d1b51c3c036` — 1 breaking
  - for the `query` request parameter `status`, default value was changed from `inactive, active` to `active, inactive`
- **2023-02-19** `33a8ac13f9bf` — 1 breaking, 1 info
  - for the `query` request parameter `status`, default value was changed from `active, inactive` to `inactive, active`
  - the `items/customer/customer_id` response's property pattern `^[-a-zA-Z0-9_]+$` was removed for the status `200`
- **2023-02-18** `333e2d1b1fe4` — 1 breaking
  - for the `query` request parameter `status`, default value was changed from `inactive, active` to `active, inactive`
- **2023-02-18** `59a3ecddd82c` — 1 breaking
  - for the `query` request parameter `status`, default value was changed from `active, inactive` to `inactive, active`

[Full history](https://skmtc.dev/uselotus/apis/lotus-api/changes/api/credits/get.md)

---

[API](https://skmtc.dev/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.dev/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uselotus/lotus-api/revisions/d246ebbb528d/schema)