Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Dimensional Price Group

Update dimensional price group

This endpoint can be used to update the external_dimensional_price_group_id and metadata of an existing dimensional price group. Other fields on a dimensional price group are currently immutable.

put/dimensional_price_groups/{dimensional_price_group_id}

Path parameters

dimensional_price_group_idstring required

Request body

metadataobject nullable

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

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

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

idstring required
namestring required

The name of the dimensional price group

external_dimensional_price_group_idstring nullable required

An alias for the dimensional price group

dimensionsstring[] required

The dimensions that this dimensional price group is defined over

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

Example response

{
  "external_dimensional_price_group_id": "my_dimensional_price_group_id",
  "dimensions": [
    "region",
    "instance_type"
  ]
}