Skip to main content
PATCH
/
v0
/
billableMetrics
/
{id}
Update
curl --request PATCH \
  --url https://api.paygentic.io/v0/billableMetrics/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "unit": "<string>",
  "eventType": "<string>",
  "valueProperty": "<string>",
  "groupBy": {},
  "eventFrom": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.paygentic.io/v0/billableMetrics/{id}"

payload = {
"description": "<string>",
"name": "<string>",
"unit": "<string>",
"eventType": "<string>",
"valueProperty": "<string>",
"groupBy": {},
"eventFrom": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
name: '<string>',
unit: '<string>',
eventType: '<string>',
valueProperty: '<string>',
groupBy: {},
eventFrom: '2023-11-07T05:31:56Z'
})
};

fetch('https://api.paygentic.io/v0/billableMetrics/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'name' => '<string>',
'unit' => '<string>',
'eventType' => '<string>',
'valueProperty' => '<string>',
'groupBy' => [

],
'eventFrom' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.paygentic.io/v0/billableMetrics/{id}"

payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"eventType\": \"<string>\",\n \"valueProperty\": \"<string>\",\n \"groupBy\": {},\n \"eventFrom\": \"2023-11-07T05:31:56Z\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.paygentic.io/v0/billableMetrics/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"eventType\": \"<string>\",\n \"valueProperty\": \"<string>\",\n \"groupBy\": {},\n \"eventFrom\": \"2023-11-07T05:31:56Z\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/billableMetrics/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"eventType\": \"<string>\",\n \"valueProperty\": \"<string>\",\n \"groupBy\": {},\n \"eventFrom\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "bm_u3v4w5x6y7z8a9b0",
  "object": "billableMetric",
  "aggregation": "SUM",
  "createdAt": "2024-02-01T14:45:30Z",
  "description": "Language model token consumption",
  "merchantId": "org_c1d2e3f4g5h6i7j8",
  "name": "LLM Tokens",
  "productId": "prod_k9l0m1n2o3p4q5r6",
  "unit": "tokens",
  "updatedAt": "2024-03-15T11:30:00Z"
}
{
"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

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$

Body

application/json
description
string

Revised explanation of what the metric represents. Sample values: 'Language model token consumption', 'Database storage capacity used', 'Machine learning prediction API calls', 'AI-generated content items'

name
string

Updated label for the metric. Sample values: 'LLM Tokens', 'Database Storage', 'Prediction Requests', 'Content Generations'

unit
string

Updated measurement unit. Common examples: 'tokens', 'GB', 'requests', 'items', 'hours'

eventType
string | null

CloudEvents type for meter routing.

valueProperty
string | null

JSONPath to extract a numeric value from event data. Must start with $. (example: $.amount or $.payload.bytes).

Pattern: ^\$\.[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)*$
groupBy
object | null

Map of dimension name to JSONPath for group-by queries. Each value must start with $. (example: $.region).

eventFrom
string<date-time> | null

Only count events after this timestamp.

Response

Billable metric updated successfully

id
string
required

Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$
object
enum<string>
default:billableMetric
required
Available options:
billableMetric
aggregation
enum<string>
required
Available options:
SUM,
COUNT,
AVG,
MIN,
MAX,
UNIQUE_COUNT,
LATEST
createdAt
string<date-time>
required
description
string
required
merchantId
string
required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
name
string
required
productId
string
required

Unique identifier for a product

Pattern: ^prod_[a-zA-Z0-9]+$
unit
string
required
updatedAt
string<date-time>
required
eventType
string | null
valueProperty
string | null
groupBy
object | null
eventFrom
string<date-time> | null