JavaScript
import Openregister from 'openregister';
const client = new Openregister({
apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});
const response = await client.usage.getCreditsV1();
console.log(response.paid);import os
from openregister import Openregister
client = Openregister(
api_key=os.environ.get("OPENREGISTER_API_KEY"), # This is the default and can be omitted
)
response = client.usage.get_credits_v1()
print(response.paid)package main
import (
"context"
"fmt"
"github.com/oregister/openregister-go"
"github.com/oregister/openregister-go/option"
)
func main() {
client := openregister.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Usage.GetCreditsV1(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Paid)
}
openregister usage get-credits-v1 \
--api-key 'My API Key'curl --request GET \
--url https://api.openregister.de/v1/credits \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openregister.de/v1/credits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.openregister.de/v1/credits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openregister.de/v1/credits")
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{
"used_credits": 123,
"included_credits": 123,
"remaining_credits": 123,
"overage_credits": 123,
"paid": true,
"period": {
"type": "billing_cycle",
"reset_at": "2023-11-07T05:31:56Z"
}
}Credit usage
GET
/
v1
/
credits
JavaScript
import Openregister from 'openregister';
const client = new Openregister({
apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});
const response = await client.usage.getCreditsV1();
console.log(response.paid);import os
from openregister import Openregister
client = Openregister(
api_key=os.environ.get("OPENREGISTER_API_KEY"), # This is the default and can be omitted
)
response = client.usage.get_credits_v1()
print(response.paid)package main
import (
"context"
"fmt"
"github.com/oregister/openregister-go"
"github.com/oregister/openregister-go/option"
)
func main() {
client := openregister.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Usage.GetCreditsV1(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Paid)
}
openregister usage get-credits-v1 \
--api-key 'My API Key'curl --request GET \
--url https://api.openregister.de/v1/credits \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openregister.de/v1/credits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.openregister.de/v1/credits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openregister.de/v1/credits")
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{
"used_credits": 123,
"included_credits": 123,
"remaining_credits": 123,
"overage_credits": 123,
"paid": true,
"period": {
"type": "billing_cycle",
"reset_at": "2023-11-07T05:31:56Z"
}
}Retrieve credit usage
Get the credits used in the current period, how many are included in your plan, and when usage resets. Paid plans reset with the billing cycle; the free plan uses a rolling 30-day window that starts with your first request. Cost: 0 creditsAuthorizations
API Key Authentication Provide your API key as a Bearer token in the Authorization header.
Rejected keys return a JSON body {"message": "..."} naming the reason:
- 401
API key is missing,API key is invalid,API key is disabledorAPI key has expired - 429
API key rate limit exceededorAPI key usage limit exceeded
Response
Successful credit usage lookup
Was this page helpful?
⌘I

