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
- 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
List dimensional price groups
curl --request GET \
--url https://api.withorb.com/v1/dimensional_price_groups \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"metadata": {},
"id": "<string>",
"name": "<string>",
"external_dimensional_price_group_id": "my_dimensional_price_group_id",
"dimensions": [
"region",
"instance_type"
],
"billable_metric_id": "<string>"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}
Authorizations
API Keys can be issued in the Orb's web application.
Query Parameters
The number of items to fetch. Defaults to 20.
1 <= x <= 100
Cursor for pagination. This can be populated by the next_cursor
value returned from the initial request.
Response
A dimensional price group is used to partition the result of a billable metric by a set of dimensions. Prices in a price group must specify the parition used to derive their usage.
User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null
, and the entire metadata mapping can be cleared by setting metadata
to null
.
The name of the dimensional price group
An alias for the dimensional price group
"my_dimensional_price_group_id"
The dimensions that this dimensional price group is defined over
["region", "instance_type"]
The billable metric associated with this dimensional price group. All prices associated with this dimensional price group will be computed using this billable metric.
Was this page helpful?
curl --request GET \
--url https://api.withorb.com/v1/dimensional_price_groups \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"metadata": {},
"id": "<string>",
"name": "<string>",
"external_dimensional_price_group_id": "my_dimensional_price_group_id",
"dimensions": [
"region",
"instance_type"
],
"billable_metric_id": "<string>"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}