> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.freecustom.email/free-custom-email-api/v-1/usage/get-usage-stats/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.freecustom.email/_mcp/server.

# Get usage stats

GET https://api2.freecustom.email/v1/usage

Returns live usage stats for the current billing period.

Reference: https://docs.freecustom.email/free-custom-email-api/v-1/usage/get-usage-stats

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Response

### 200

OK

- `success` (boolean, required)
- `data` (V1UsageGetResponsesContentApplicationJsonSchemaData, required)

## Errors

### 401 Unauthorized Error

Unauthorized

- `success` (boolean, required)
- `error` (string, required)
- `message` (string, required)

### 429 Too Many Requests Error

Too Many Requests

- `success` (boolean, required)
- `error` (string, required)
- `message` (string, required)
- `upgrade_url` (string, required)
- `credits_url` (string, required)
- `hint` (string, required)

## Types

### V1UsageGetResponsesContentApplicationJsonSchemaData

- `plan` (string, required)
- `period` (V1UsageGetResponsesContentApplicationJsonSchemaDataPeriod, required)
- `requests` (V1UsageGetResponsesContentApplicationJsonSchemaDataRequests, required)
- `credits` (V1UsageGetResponsesContentApplicationJsonSchemaDataCredits, required)
- `rate_limit` (V1UsageGetResponsesContentApplicationJsonSchemaDataRateLimit, required)

### V1UsageGetResponsesContentApplicationJsonSchemaDataPeriod

- `month` (string, required)
- `resets_at` (datetime, required)

### V1UsageGetResponsesContentApplicationJsonSchemaDataRequests

- `used` (integer, required)
- `limit` (integer, required)
- `remaining` (integer, required)
- `percent_used` (double, required)

### V1UsageGetResponsesContentApplicationJsonSchemaDataCredits

- `balance` (integer, required)
- `note` (string, required)

### V1UsageGetResponsesContentApplicationJsonSchemaDataRateLimit

- `requests_per_second` (integer, required)

## Examples

**Response**

```json
{
  "success": true,
  "data": {
    "plan": "string",
    "period": {
      "month": "string",
      "resets_at": "1955-06-14T01:21:44.649Z"
    },
    "requests": {
      "used": 183,
      "limit": 9548,
      "remaining": 7856,
      "percent_used": 7322.556944918989
    },
    "credits": {
      "balance": 6153,
      "note": "string"
    },
    "rate_limit": {
      "requests_per_second": 3792
    }
  }
}
```

**SDK Code**

```python v1_usage_Get usage stats_example
import requests

url = "https://api2.freecustom.email/v1/usage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript v1_usage_Get usage stats_example
const url = 'https://api2.freecustom.email/v1/usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go v1_usage_Get usage stats_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api2.freecustom.email/v1/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby v1_usage_Get usage stats_example
require 'uri'
require 'net/http'

url = URI("https://api2.freecustom.email/v1/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java v1_usage_Get usage stats_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api2.freecustom.email/v1/usage")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php v1_usage_Get usage stats_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api2.freecustom.email/v1/usage', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp v1_usage_Get usage stats_example
using RestSharp;

var client = new RestClient("https://api2.freecustom.email/v1/usage");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift v1_usage_Get usage stats_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api2.freecustom.email/v1/usage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```