Skip to main content
GET
/
v0
/
billableMetrics
/
{id}
Get
curl --request GET \
  --url https://api.paygentic.io/v0/billableMetrics/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "bm_u3v4w5x6y7z8a9b0",
  "object": "billableMetric",
  "aggregation": "SUM",
  "createdAt": "2024-02-01T14:45:30Z",
  "description": "Gigabytes of cloud storage utilized",
  "merchantId": "org_c1d2e3f4g5h6i7j8",
  "name": "Storage Capacity",
  "productId": "prod_k9l0m1n2o3p4q5r6",
  "taxRate": 10,
  "unit": "GB",
  "updatedAt": "2024-02-15T09:20:00Z"
}

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]+$

Response

Billable metric details

​
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
​
eventFrom
string<date-time> | null