list metering dimensions of product
GET https://api.suger.cloud/org/{orgId}/product/{productId}/dimension
list all metering dimensions of the given product
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
productId | path | string | yes | Product ID |
Responses
200 — OK
Content-Type: application/json
MeteringDimension fields:
| Field | Type | Required | Description |
|---|---|---|---|
category | string | no | |
description | string | no | |
includedBaseQuantities | array<AzureIncludedBaseQuantity> | no | how many quantities of this dimension are included in the commit. |
key | string | no | |
name | string | no | Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix. |
planId | string | no | The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix. |
planName | string | no | The name of the plan for the metering dimension. Applicable to GCP Marketplace only. It may contains the ISO duration suffix, such as P1Y. |
priceTiers | array<GcpPriceTier> | no | The price tiers of the metering dimension. Applicable to GCP Marketplace only. |
rate | number | no | The unit price of this usage metering dimension. |
skuId | string | no | The SKU ID of the metering dimension. Applicable to GCP Marketplace only. |
types | array<string> | no | |
usageCount | UsageCount | no | |
valueType | ValueType | no |
AzureIncludedBaseQuantity fields:
| Field | Type | Required | Description |
|---|---|---|---|
isInfinite | boolean | no | |
quantity | number | no | |
recurringUnit | string | no |
GcpPriceTier fields:
| Field | Type | Required | Description |
|---|---|---|---|
fromAmount | number | no | such as 0 |
price | GcpPriceValue | no | |
startingUsageAmount | string | no | such as "0" |
UsageCount fields:
| Field | Type | Required | Description |
|---|---|---|---|
creditCount | number | no | The count of this dimension usage records that are handled as credit. |
includedCount | number | no | The count of this dimension usage records that are handled as included in IncludedBaseQuantity |
reportedCount | number | no | The count of this dimension usage records that are reported to cloud vendors. |
GcpPriceValue fields:
| Field | Type | Required | Description |
|---|---|---|---|
currencyCode | string | no | such as "USD" |
nanos | integer | no | for the decimal part, such as 30000000 = $0.03 |
units | string | no | for the integer part, such as "500000" = $50K |
400 — Bad request error
Content-Type: application/json
404 — Not found error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.