API documentation
Alert
Customer
- GETList customers
- POSTCreate customer
- GETFetch customer by external ID
- PUTUpdate customer by external ID
- GETFetch customer costs by external ID
- POSTUpdate payment methods from payment provider
- GETFetch customer
- PUTUpdate customer
- DELDelete customer
- GETList balance transactions
- POSTCreate customer balance transaction
- GETFetch customer costs
- POSTUpdate payment methods from payment provider
Credit
- GETFetch customer credit balance by external customer id
- GETFetch customer credits ledger by external ID
- POSTCreate ledger entry by external ID
- GETList top-ups by external ID
- POSTCreate top-up by external ID
- DELDeactivate top-up by external ID
- GETFetch customer credit balance
- GETFetch customer credits ledger
- POSTCreate ledger entry
- GETList top-ups
- POSTCreate top-up
- DELDeactivate top-up
Dimensional Price Group
Event
Invoice
Availability
Plan
Price
Subscription Change
Subscription
- GETList subscriptions
- POSTCreate subscription
- GETFetch subscription
- PUTUpdate subscription
- POSTCancel subscription
- GETFetch subscription costs
- GETFetch subscription schedule
- POSTSchedule plan change
- POSTTrigger phase
- POSTUnschedule subscription cancellation
- POSTUnschedule fixed fee quantity updates
- POSTUnschedule plan change
- POSTUpdate price quantity
- POSTUpdate trial for subscription
- GETFetch subscription usage
Price interval
Metric
Create metric
This endpoint is used to create a metric using a SQL string. See SQL support for a description of constructing SQL queries with examples.
POST
/
metrics
curl --request POST \
--url https://api.withorb.com/v1/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {},
"sql": "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = '\''fast'\''",
"name": "Bytes downloaded",
"item_id": "<string>",
"description": "Sum of bytes downloaded in fast mode"
}'
{
"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>"
}
]
}
}
Authorizations
API Keys can be issued in the Orb's web application.
Body
application/json
Response
201
application/json
Created
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?
curl --request POST \
--url https://api.withorb.com/v1/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {},
"sql": "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = '\''fast'\''",
"name": "Bytes downloaded",
"item_id": "<string>",
"description": "Sum of bytes downloaded in fast mode"
}'
{
"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>"
}
]
}
}