POST
/
dimensional_price_groups
curl --request POST \
  --url https://api.withorb.com/v1/dimensional_price_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "name": "<string>",
  "external_dimensional_price_group_id": "<string>",
  "dimensions": [
    "region",
    "instance_type"
  ],
  "billable_metric_id": "<string>"
}'
{
  "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.

Body

application/json
​
name
string
required
​
dimensions
string[]
required

The set of keys (in order) used to disambiguate prices in the group.

Minimum length: 1
Examples:
["region", "instance_type"]
​
billable_metric_id
string
required
​
metadata
object | null

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
external_dimensional_price_group_id
string | null

Response

201
application/json

Created

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

Examples:

"my_dimensional_price_group_id"

​
dimensions
string[]
required

The dimensions that this dimensional price group is defined over

Minimum length: 1
Examples:
["region", "instance_type"]
["size"]
​
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.