List Meter Events
curl --request GET \
--url https://api.paygentic.io/v0/billableMetrics/{id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paygentic.io/v0/billableMetrics/{id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paygentic.io/v0/billableMetrics/{id}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paygentic.io/v0/billableMetrics/{id}/events",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paygentic.io/v0/billableMetrics/{id}/events"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/billableMetrics/{id}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paygentic.io/v0/billableMetrics/{id}/events")
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{
"object": "list",
"billableMetricId": "<string>",
"events": [
{
"id": "<string>",
"object": "meterEvent",
"type": "<string>",
"source": "<string>",
"subject": "<string>",
"time": "2023-11-07T05:31:56Z",
"idempotencyKey": "<string>",
"data": {},
"externalId": "<string>",
"externalSubject": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}{
"message": "The requested resource was not found",
"error": "not_found"
}{
"message": "The requested resource was not found",
"error": "not_found"
}{
"message": "The requested resource was not found",
"error": "not_found"
}Billable Metrics
List Meter Events
List raw underlying events for a billable metric from the metering service. Returns events ordered by time descending.
GET
/
v0
/
billableMetrics
/
{id}
/
events
List Meter Events
curl --request GET \
--url https://api.paygentic.io/v0/billableMetrics/{id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paygentic.io/v0/billableMetrics/{id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paygentic.io/v0/billableMetrics/{id}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paygentic.io/v0/billableMetrics/{id}/events",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paygentic.io/v0/billableMetrics/{id}/events"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/billableMetrics/{id}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paygentic.io/v0/billableMetrics/{id}/events")
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{
"object": "list",
"billableMetricId": "<string>",
"events": [
{
"id": "<string>",
"object": "meterEvent",
"type": "<string>",
"source": "<string>",
"subject": "<string>",
"time": "2023-11-07T05:31:56Z",
"idempotencyKey": "<string>",
"data": {},
"externalId": "<string>",
"externalSubject": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}{
"message": "The requested resource was not found",
"error": "not_found"
}{
"message": "The requested resource was not found",
"error": "not_found"
}{
"message": "The requested resource was not found",
"error": "not_found"
}Authorizations
API key authentication
Path Parameters
Unique identifier for a billable metric
Pattern:
^bm_[a-zA-Z0-9]+$Query Parameters
Start of query window (ISO 8601)
End of query window (ISO 8601)
Filter by subject (typically the customer/user ID)
Maximum number of events to return
Required range:
1 <= x <= 200Number of events to skip
Required range:
x >= 0Filter by external identifier. Alphanumeric characters, hyphens, and underscores only. Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.
Maximum string length:
255Pattern:
^[a-zA-Z0-9_-]+$Filter by the merchant's own customer identifier the event was reported with. Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.
Maximum string length:
255Pattern:
^[a-zA-Z0-9_-]+$Response
Raw events list
Was this page helpful?