# Retrieve a usage

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


**Advanced Usage-Based Billing**

For high-scale usage ingestion, use [Advanced Usage-Based Billing](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages) with the [Usage Events API](/docs/api/usage_events). The Usage Events API supports schemaless event ingestion at scale, including [individual events](/docs/api/usage_events/create-a-usage-event), [batch ingestion](/docs/api/usage_events/ingest-usages-in-batch), and [usage file ingestion](/docs/api/usage_files/usage-file-object).

Retrieves a usage record of a specific subscription. This endpoint is part of the [Usages API](/docs/api/usages) for **Automated Metered Billing**.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__XpbBrciSCKqL28j/usages \
     -G  \
     -u {site_api_key}:\
     -d id="usage_XpbBrciSCKqL5vm"
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Usage.Retrieve("__test__XpbBrciSCKqL28j")
		.Id("usage_XpbBrciSCKqL5vm")
		.Request();

Usage usage = result.Usage;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    usageAction "github.com/chargebee/chargebee-go/v3/actions/usage"
    "github.com/chargebee/chargebee-go/v3/models/usage"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := usageAction.Retrieve("__test__XpbBrciSCKqL28j", &usage.RetrieveRequestParams{
        Id : "usage_XpbBrciSCKqL5vm",
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Usage := res.Usage
    }
}
```

#### 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.UsageRetrieveRequest{
    Id : "usage_XpbBrciSCKqL5vm",
}
  res, err := client.Usage.Retrieve("__test__XpbBrciSCKqL28j", req)
      if err != nil {
        fmt.Println(err)
    } else {
        Usage := res.Usage
    }
}
```

#### Java

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

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Usage.retrieve("__test__XpbBrciSCKqL28j")
            .id("usage_XpbBrciSCKqL5vm")
            .request();

        Usage usage = result.usage();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.usage.Usage;
import com.chargebee.v4.models.usage.params.UsageRetrieveParams;
import com.chargebee.v4.models.usage.responses.UsageRetrieveResponse;

public class UsageRetrieve {

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

        UsageRetrieveParams params = UsageRetrieveParams.builder()
            .id("usage_XpbBrciSCKqL5vm")
            .build();

        UsageRetrieveResponse response = client
            .usages()
            .retrieve("__test__XpbBrciSCKqL28j", params);

        Usage usage = response.getUsage();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.usage.retrieve("__test__XpbBrciSCKqL28j", {
        id: "usage_XpbBrciSCKqL5vm"
    });

    console.log(result);
    const usage = result.usage;
} 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->usage()->retrieve("__test__XpbBrciSCKqL28j", [
    "id" => "usage_XpbBrciSCKqL5vm"
]);
$usage = $result->usage;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Usage.retrieve("__test__XpbBrciSCKqL28j",
    cb_client.Usage.RetrieveParams(
        id="usage_XpbBrciSCKqL5vm"
    )
)
usage = response.usage
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::Usage.retrieve("__test__XpbBrciSCKqL28j",{
  :id => "usage_XpbBrciSCKqL5vm"
})

usage = result.usage
```

## Sample Response

```json
{
  "usage": {
    "created_at": 1601708191,
    "id": "usage_XpbBrciSCKqL5vm",
    "item_price_id": "silver-usd",
    "note": "Day 1 usage from __test__XpbBrciSCKqKzeh",
    "object": "usage",
    "quantity": "5",
    "resource_version": 1601708191233,
    "subscription_id": "__test__XpbBrciSCKqL28j",
    "updated_at": 1601708191,
    "usage_date": 1601718991
  }
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/usages

## Input Parameters

- `id` (required, string, max chars=100)
  The unique identifier for the usage record to be retrieved.

## Returns

- `usage` (Usage object)
  Resource object representing usage record.