---
title: "List Credit Balances for a customer"
method: GET
path: "/credits/{customerId}/balances"
tags: ["Credits"]
---

# List Credit Balances for a customer

`GET /credits/{customerId}/balances`

List all Credit Balances including their grants and transactions

## Path parameters

- `customerId` string, required

## Headers

- `Authorization` string, required
- `sequence-version` '2024-07-30'

## Response `200`

OK

- CreditBalancesReply
  - `items` CreditBalance[], required
    - `id` string, required — Indicates the ID of Credit target, either a currency code or a metric id
    - `type` 'CASH' | 'USAGE', required
    - `name` string, required — Name of the Credit - will either be the currency or name of the metric
    - `balance` string, required — Amount remaining of Credits Granted
    - `grants` CreditGrant2[], required — Related credit grants
      - `id` string, required — Credit Grant ID
      - `sequenceAccountId` string, required — Sequence account ID
      - `customerId` string, required — Customer ID
      - `type` 'CASH' | 'USAGE', required
      - `currency` 'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR', required
      - `metricId` string — Usage metric ID (if type is USAGE)
      - `name` string, required — Name of the Credit - will either be the currency or name of the metric
      - `originalAmount` string, required — Amount of credits originally granted
      - `currentBalance` string, required — Amount remaining of Credits Granted
      - `expiryDate` string — Last Day Credit Grant can be consumed
      - `costOfCredit` string, required — Cost of credit grant
      - `taxRateId` string — Tax Rate ID for Credit Purchase
      - `effectiveDate` string — First Day Credit Grant can be consumed
      - `createdAt` string, required — The created at
    - `transactions` CreditTransaction[], required — Related credit transactions
      - `id` string — Credit Transaction ID
      - `grantId` string, required — Credit Grant ID
      - `reason` string — Transaction Reason
      - `invoiceId` string — Invoice ID where Credit was consumed
      - `billingRunId` string — Billing Run ID where Credit was consumed
      - `type` 'DEBIT' | 'CREDIT', required
      - `amount` string, required — Number of units added or consumed
      - `date` string, required — Date of transaction

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

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