curl --request PUT \
--url https://api.withorb.com/v1/metrics/{metric_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {}
}'
{
"metadata": {},
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"item": {
"metadata": {},
"id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"external_connections": [
{
"external_connection_name": "stripe",
"external_entity_id": "<string>"
}
]
}
}
This endpoint allows you to update the metadata
property on a metric. If you pass null
for the metadata value,
it will clear any existing metadata for that invoice.
curl --request PUT \
--url https://api.withorb.com/v1/metrics/{metric_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {}
}'
{
"metadata": {},
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "active",
"item": {
"metadata": {},
"id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"external_connections": [
{
"external_connection_name": "stripe",
"external_entity_id": "<string>"
}
]
}
}
API Keys can be issued in the Orb's web application.
OK
The Metric resource represents a calculation of a quantity based on events. Metrics are defined by the query that transforms raw usage events into meaningful values for your customers.
Was this page helpful?