Skip to main content
PUT
/
dimensional_price_groups
/
external_dimensional_price_group_id
/
{external_dimensional_price_group_id}
Update dimensional price group by external ID
curl --request PUT \
  --url https://api.withorb.com/v1/dimensional_price_groups/external_dimensional_price_group_id/{external_dimensional_price_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "external_dimensional_price_group_id": "<string>"
}
'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "external_dimensional_price_group_id": "my_dimensional_price_group_id",
  "dimensions": [
    "<string>"
  ],
  "billable_metric_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
external_dimensional_price_group_id
string
required

Body

application/json
​
metadata
Metadata · object

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

An optional user-defined ID for this dimensional price group resource, used throughout the system as an alias for this dimensional price group. Use this field to identify a dimensional price group by an existing identifier in your system.

Response

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
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

Minimum array length: 1
​
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.