Skip to main content

update usage metering config info

PATCH 
/org/:orgId/usageMeteringConfigInfo

Update the usage metering config info of the given organization.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Body

required

The usage metering config info to be updated

    partnerUsageMeteringConfigs

    object[]

    The usage metering configuration for each Partner, such as AWS, AZURE & GCP.

  • Array [

    • dimensionMapping

    object

    The mapping of the source dimension key to the destination dimension key of the usage metering.

    property name*

    UsageMeteringDimensionMappingValue

    convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

    dimensionMappingV2

    object

    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.

    property name*

    object[]

  • Array [

    • convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

  • ]

    • enableBillableDimension boolean
    enableCommitWithAdditionalUsageAtListPrice boolean

    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

    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

    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 (string)

    Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]

  • ]

Responses​

Usage metering config info

Schema

    partnerUsageMeteringConfigs

    object[]

    The usage metering configuration for each Partner, such as AWS, AZURE & GCP.

  • Array [

    • dimensionMapping

    object

    The mapping of the source dimension key to the destination dimension key of the usage metering.

    property name*

    UsageMeteringDimensionMappingValue

    convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

    dimensionMappingV2

    object

    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.

    property name*

    object[]

  • Array [

    • convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

  • ]

    • enableBillableDimension boolean
    enableCommitWithAdditionalUsageAtListPrice boolean

    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

    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

    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 (string)

    Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]

  • ]

Loading...