cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/usages/usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.usages.get_usage("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.usages.getUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->usages->getUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.usages.usages_dto.UsagesDto.Usage;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Usage> response = client.usages().getUsage("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Usages.GetUsageAsync("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.usages.getUsage(
'usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Usages().GetUsage(context.Background(), "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"usage": {
"charge_item": {
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"charging_end_date": "<string>",
"charging_period": "<string>",
"charging_start_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"end_time": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"quantity": 123,
"source": "<unknown>",
"start_time": "<string>",
"status": "<string>",
"type": "<string>",
"uom": "<unknown>",
"version": 123
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Usages
Retrieve a usage
Returns one usage, under usage.
GET
/
usages
/
{usage_id}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/usages/usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.usages.get_usage("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.usages.getUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->usages->getUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.usages.usages_dto.UsagesDto.Usage;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Usage> response = client.usages().getUsage("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Usages.GetUsageAsync("usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.usages.getUsage(
'usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Usages().GetUsage(context.Background(), "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"usage": {
"charge_item": {
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"charging_end_date": "<string>",
"charging_period": "<string>",
"charging_start_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"end_time": "<string>",
"href": "<string>",
"id": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"quantity": 123,
"source": "<unknown>",
"start_time": "<string>",
"status": "<string>",
"type": "<string>",
"uom": "<unknown>",
"version": 123
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Pass the usage’s
id. The response holds the quantity, the times, the charging period and the order line it is billed on, under charge_item.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token.