GET
/
dimensional_price_groups
/
{dimensional_price_group_id}
curl --request GET \
  --url https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "external_dimensional_price_group_id": "my_dimensional_price_group_id",
  "dimensions": [
    "region",
    "instance_type"
  ],
  "billable_metric_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
dimensional_price_group_id
string
required

Response

200
application/json
OK

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.

​
metadata
object
required

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.

​
id
string
required
​
name
string
required

The name of the dimensional price group

​
external_dimensional_price_group_id
string | null
required

An alias for the dimensional price group

Example:

"my_dimensional_price_group_id"

​
dimensions
string[]
required

The dimensions that this dimensional price group is defined over

Example:
["region", "instance_type"]
​
billable_metric_id
string
required

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?