Suger

update usage metering config info

PATCH https://api.suger.cloud/org/{orgId}/usageMeteringConfigInfo

Update the usage metering config info of the given organization.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID

Request Body

Required. Content-Type: application/json · Schema: UsageMeteringConfigInfo

UsageMeteringConfigInfo fields:

FieldTypeRequiredDescription
partnerUsageMeteringConfigs array<PartnerUsageMeteringConfig> no The usage metering configuration for each Partner, such as AWS, AZURE & GCP.

PartnerUsageMeteringConfig fields:

FieldTypeRequiredDescription
dimensionMapping object no Deprecated: Use DimensionMappingV2 instead. The mapping of the source dimension key to the destination dimension key of the usage metering.
dimensionMappingV2 object no The mapping of the source dimension key to the destination dimension keys of the usage metering. The destination dimension keys are the list of the destination dimension keys. So the source dimension key can be mapped to multiple destination dimension keys.
enableBillableDimension boolean no
enableCommitWithAdditionalUsageAtListPrice boolean no Enable the commit (discount) with additional usage metering at list price. Only applicable if EnableCommitWithAdditionalUsageMetering is true. The default is false, which means the commit with additional usage metering at the discounted price in the private offer. If set to true, the additional usage is metered at the list price (the price in public product listing) instead of the discounted price.
enableCommitWithAdditionalUsageMetering boolean no Enable the commit with additional usage metering. The default is false, which means all usage records are reported to partner no matter how much is the commit. If set to true, the usage records will be reported to partner only if the current commit has been exhausted.
enableDimensionMapping boolean no Enable the dimension mapping for the usage metering. The default is false, which means no dimension conversion and just use the origin dimension.
partner Partner no

Responses

200 — Usage metering config info

Content-Type: application/json · Schema: UsageMeteringConfigInfo

UsageMeteringConfigInfo fields:

FieldTypeRequiredDescription
partnerUsageMeteringConfigs array<PartnerUsageMeteringConfig> no The usage metering configuration for each Partner, such as AWS, AZURE & GCP.

PartnerUsageMeteringConfig fields:

FieldTypeRequiredDescription
dimensionMapping object no Deprecated: Use DimensionMappingV2 instead. The mapping of the source dimension key to the destination dimension key of the usage metering.
dimensionMappingV2 object no The mapping of the source dimension key to the destination dimension keys of the usage metering. The destination dimension keys are the list of the destination dimension keys. So the source dimension key can be mapped to multiple destination dimension keys.
enableBillableDimension boolean no
enableCommitWithAdditionalUsageAtListPrice boolean no Enable the commit (discount) with additional usage metering at list price. Only applicable if EnableCommitWithAdditionalUsageMetering is true. The default is false, which means the commit with additional usage metering at the discounted price in the private offer. If set to true, the additional usage is metered at the list price (the price in public product listing) instead of the discounted price.
enableCommitWithAdditionalUsageMetering boolean no Enable the commit with additional usage metering. The default is false, which means all usage records are reported to partner no matter how much is the commit. If set to true, the usage records will be reported to partner only if the current commit has been exhausted.
enableDimensionMapping boolean no Enable the dimension mapping for the usage metering. The default is false, which means no dimension conversion and just use the origin dimension.
partner Partner no

400 — Bad request 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.