# List credit units

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Eventually Consistent](/docs/api/read-consistency)

Retrieves a paginated list of credit units meeting **all** the conditions specified in the filter parameters.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/credit_units \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=10 \
     --data-urlencode "status[is]"="ACTIVE"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = CreditUnit.List()
		.Limit(10)
		.Status().Is(CreditUnit.StatusEnum.Active)
		.Request();

foreach (var listItem in result.List){
  CreditUnit creditUnit = listItem.CreditUnit;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    creditunitAction "github.com/chargebee/chargebee-go/v3/actions/creditunit"
    "github.com/chargebee/chargebee-go/v3/models/creditunit"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := creditunitAction.List(&creditunit.ListRequestParams{
        Limit : chargebee.Int32(10),
        Status : &filter.EnumFilter{
            Is : "active",
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            CreditUnit := res.List[idx].CreditUnit
        }
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CreditUnitListRequest{
    Limit : chargebee.Int32(10),
    Status : &chargebee.EnumFilter{
        Is : "active",
    },
}
  res, err := client.CreditUnit.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            CreditUnit := res.List[idx].CreditUnit
        }
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        ListResult result = CreditUnit.list()
            .limit(10)
            .status().is(CreditUnit.Status.ACTIVE)
            .request();

        for (ListResult.Entry entry : result) {
            CreditUnit creditUnit = entry.creditUnit();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.creditUnit.CreditUnit;
import com.chargebee.v4.models.creditUnit.params.CreditUnitListParams;
import com.chargebee.v4.models.creditUnit.responses.CreditUnitListResponse;
import java.util.List;

public class CreditUnitList {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CreditUnitListParams params = CreditUnitListParams.builder()
            .limit(10)
            .status()
            .is(CreditUnitListParams.Status.ACTIVE)
            .build();

        CreditUnitListResponse response = client.creditUnits().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.creditUnit.list({
        limit: 10,
        status: {
            is: "active"
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const creditUnit = entry.credit_unit;
    });
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->creditUnit()->all([
    "limit" => 10,
    "status" => [
        "is" => "active"
    ]
]);
foreach($result->list as $entry) {
    $creditUnit = $entry->credit_unit;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.CreditUnit.list(
    cb_client.CreditUnit.ListParams(
        limit=10,
        status=Filters.EnumFilter(IS=chargebee.CreditUnit.Status.ACTIVE)
    )
)
for entry in entries.list:
    credit_unit = entry.credit_unit
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

list = ChargeBee::CreditUnit.list({
  :limit => 10,
  "status[is]" => "active"
})

list.each do |entry|
  credit_unit = entry.credit_unit
end
```

## Sample Response

```json
{
  "list": [
    {
      "credit_unit": {
        "id": "ai_tokens_001",
        "name": "AI tokens",
        "external_name": "AI tokens",
        "status": "active",
        "resource_version": 1784633640000,
        "is_unlimited": false,
        "overdraft_amount": "1000",
        "created_at": 1784633586,
        "created_by": "sample.user@chargebee.com",
        "updated_at": 1784633640,
        "updated_by": "sample.user@chargebee.com"
      }
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/credit_units

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `credit_unit` (Credit unit object)
  Resource object representing credit unit