Billing Status API
โ BackRetrieve real-time information about your API usage, remaining free calls, and billing credits.
๐ Endpoint
GET /api/billing/status
This endpoint returns your current billing and usage status based on your API key.
๐งพ Sample Response
{
"FreeRowsRemaining": 3,
"creditsRemaining": 45,
"RowsToNextCredit": 7
}
- FreeRowsRemaining โ Remaining daily calls on the free tier
- creditsRemaining โ Available paid credits
- RowsToNextCredit โ Calls remaining before 1 credit is consumed
๐งช Code Examples
curl -X GET https://yourdomain.com/api/billing/status \
-H "X-API-KEY: YOUR_API_KEY"
const response = await fetch(
"https://yourdomain.com/api/billing/status",
{
headers: {
"X-API-KEY": process.env.API_KEY
}
}
);
const status = await response.json();
console.log(status);
import requests
url = "https://yourdomain.com/api/billing/status"
headers = {
"X-API-KEY": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
using System.Net.Http;
var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");
var response = await client.GetAsync(
"https://yourdomain.com/api/billing/status");
var json = await response.Content.ReadAsStringAsync();
$headers = "X-API-KEY" = "YOUR_API_KEY"
}
$response = Invoke-RestMethod `
-Uri "https://yourdomain.com/api/billing/status" `
-Method Get `
-Headers $headers
$response
๐ Security & Access
- Requires a valid API key
- Returns data only for the authenticated user
- HTTPS enforced
- No sensitive billing data is exposed
Tip: Call this endpoint before large jobs to ensure you have sufficient usage available.