Quote the CPQ Usage Price

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote

Body Parameters

bodypayment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.in
- customerIdstringrequired
  Description
  The unique ID for the customer.
- customProductPlanGeneratorpayment.pricing.plans.generators.PlanGenerator.in
  Description
  A custom product plan for the calculator.
  - payment.pricing.plans.generators.CustomPlanGenerator.in
    - typestring
      Description
      Type of template, automatically populated.
      Default
      custom_pricing_plan
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.inrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.in
      - intervalsCountinteger<int32>
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - planMinimumPaymentnumber
      Description
      A minimum payment for the entire plan.
    - minimumPaymentGranularitypayment.pricing.price.UsageGranularity.in
      Description
      Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - feeMapmap<string, payment.pricing.ProductPlanFee.in>
      Description
      Fee Id to fee that maps to product plan fee.
    - entitlementspayment.pricing.Entitlements.Entitlement.in[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
      Description
      Indicates if the plan can be modified or not.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.in
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.in
      Description
      Rules for the prepaid
      - planFixedFeeIdsToPrepaystring[]
      - planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
      - productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.in[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        productItemIdstring
        Description
        Product item id that is associated with amount of prepaid.
        prepaidAmountnumber
        Description
        Prepaid amount that is associated with the object.
      - walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
      - productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
    - planCurrencystring
      Example
      USD
      Description
      The customized currency for the plan in ISO 4217 format.
    - priceGeneratorspayment.pricing.price.generators.PriceGenerator.in[]required
      Description
      List of price generators to use in the plan. Can be any price generator.
      - payment.pricing.price.generators.CostPlusDimensionPriceGenerator.in
        dimensionKeysstring[]required
        Description
        Keys associated with dimension values.
        idstring
        Description
        Id associated with the price.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        lockingStatuscom.amberflo.service.common.LockingStatus.in
        Description
        Indicates if the meter can be modified or not.
        scalarnumber
        Description
        Scalar value used to scale usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.in[]
        Description
        Scalars for scaling usage by dimensions
        dimensionConstraintMapmap<string, string>
        scalarnumber
        priceTierspayment.pricing.price.generators.TieredPriceGroupInfo.in[]required
        Description
        Price for each tier. Leaf node type must be LeafNode
        dimensionValuesstring[]
        priceTierspayment.pricing.price.PriceTier.in[]
        Max depth limit reached
        leafNodeTypestringrequired
        allowPartialBatchboolean
        Description
        Count tier rates in cents.
        typestring
        Description
        Type of template, automatically populated.
        Default
        cost_plus_dimension
      - payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.in
        idstring
        Description
        Id associated with the price.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        scalarnumber
        Description
        Scalar value used to scale usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.in[]
        Description
        Scalars for scaling usage by dimensions
        Max depth limit reached
        priceTierspayment.pricing.price.PriceTier.in[]required
        Description
        Price for each tier.
        Max depth limit reached
        allowPartialBatchboolean
        Description
        Count tier rates in cents.
        typestring
        Description
        Type of template, automatically populated.
        Default
        cost_plus_no_dimension
      - payment.pricing.price.generators.FlatRatePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.TieredSeatBasedGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in
        Max depth limit reached
    - invoiceBasedFeespayment.pricing.invoice_based_fees.InvoiceBasedFee.in[]
      Description
      The service fees for the invoice.
      - payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.in
        typestring
        Default
        constant_invoice_ratio_fee
        productIdstring
        idstring
        namestring
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.in
        lastUpdateTimeInMillisinteger<int64>
        percentsOfInvoicenumber
        minimumFeePerFullCyclenumber
  - payment.pricing.plans.generators.FlatRatePlanGenerator.in
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.inrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.in
      - intervalsCountinteger<int32>
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - priceGeneratorspayment.pricing.price.generators.FlatRatePriceGenerator.in[]required
      Description
      List of price generators to use in the plan. Must be strictly flat rate.
      - idstringrequired
        Description
        Id associated with the price.
      - flatRatenumberrequired
        Description
        Amount intended to be charged.
      - productItemIdstringrequired
        Description
        Product item id associated with the price.
      - lockingStatuscom.amberflo.service.common.LockingStatus.in
        Description
        Indicates if the meter can be modified or not.
      - productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
      - productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
      - scalarnumber
        Description
        Optional scalar for scaling usage
      - dimensionalScalarspayment.pricing.price.DimensionalScalar.in[]
        Description
        Optional scalars for scaling usage by dimensions
        dimensionConstraintMapmap<string, string>
        scalarnumber
      - usageTransformerpayment.pricing.UsageTransformer.in
        Description
        Optional usage transformer. May include just transformer id if the transformer already exists.
        idstring
        Description
        Unique identifier for a particular usage transformer.
        namestring
        Description
        Name given to the usage transformer.
        transformUsageDimensionNamestring
        Description
        Name of the dimension used to transform / scale usage.
        productItemIdstring
        Description
        Product item id associated with the usage transformer.
        dimensionsInterpolationscom.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.in[]
        Description
        List of dimension interpolations, used to derive new dimensions and their values.
        com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.in
        Max depth limit reached
        com.amberflo.service.common.dimensions_interpolation.TableInterpolation.in
        Max depth limit reached
        com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.in
        Max depth limit reached
        requiredDimensionsstring[]
        lockingStatuscom.amberflo.service.common.LockingStatus.in
        Max depth limit reached
        lastUpdateTimeInMillisinteger<int64>
      - typestring
        Description
        Type of template, automatically populated.
        Default
        flat_rate
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
      Description
      Indicates if the plan can be modified or not.
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.in
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - entitlementspayment.pricing.Entitlements.Entitlement.in[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - typestring
      Description
      Type of template, automatically populated.
      Default
      flat_rate
  - payment.pricing.plans.generators.PayAndGoPlanGenerator.in
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.inrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - intervalpayment.pricing.BillingPeriodInterval.in
        Max depth limit reached
      - intervalsCountinteger<int32>
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.inrequired
      Description
      Pay and Go prepaid credit purchasing information.
      - planFixedFeeIdsToPrepaystring[]
      - planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
      - productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.in[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        Max depth limit reached
      - walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
      - productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
    - priceGeneratorspayment.pricing.price.generators.UsageBasedPriceGenerator.in[]required
      Description
      List of price generators to use in the plan. Must be usage-based.
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in
        Max depth limit reached
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - feeMapmap<string, payment.pricing.ProductPlanFee.in>
      Description
      Fixed fees to attach to product plan.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of ids for invoice based fees that are added to the invoice.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
      Description
      Indicates if the plan can be modified or not.
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.in
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
    - entitlementspayment.pricing.Entitlements.Entitlement.in[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - idstringrequired
        Description
        Id for the Entitlement.
      - labelstring
        Description
        Label for the Entitlement.
      - apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
    - typestring
      Description
      Type of template, automatically populated.
      Default
      pay_and_go
  - payment.pricing.plans.generators.UsageBasedPlanGenerator.in
    - idstringrequired
      Description
      Id associated with the plan.
    - billingPeriodpayment.pricing.BillingPeriod.inrequired
      Description
      Billing period of the plan: how often an invoice is generated.
      - Max depth limit reached
    - planNamestringrequired
      Description
      Name of the plan. Useful for displaying to users.
    - priceGeneratorspayment.pricing.price.generators.UsageBasedPriceGenerator.in[]required
      Description
      List of price generators to use in the plan. Must be usage-based.
      - payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in
        Max depth limit reached
      - payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in
        Max depth limit reached
    - descriptionstring
      Description
      Description of the plan. Useful for displaying to users.
    - invoiceBasedFeeIdsstring[]
      Description
      A set of fee ids that can calculate an invoice's cost in a custom way.
    - isDefaultboolean
      Description
      Indicates if the plan is the default plan for users.
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
      Description
      Indicates if the plan can be modified or not.
      - Max depth limit reached
    - planLevelFreeTiernumber
      Description
      Amount that user can use for free without paying on a plan level.
    - successorPlanIdstring
      Description
      Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
    - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.in
      Description
      Successor plan transition: whether to wait for end of billing cycle or not.
      - Max depth limit reached
    - entitlementspayment.pricing.Entitlements.Entitlement.in[]
      Description
      A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
      - Max depth limit reached
    - typestring
      Description
      Type of template, automatically populated.
      Default
      pure_usage_based
  - payment.pricing.plans.generators.SeatBasedPlanGenerator.in
    - Max depth limit reached
  - payment.pricing.plans.generators.SubscriptionPlanGenerator.in
    - Max depth limit reached
- productPlanIdstring
  Description
  The unique ID for the product plan.
- intervalUsagespayment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.in[]required
  Description
  The list of intervals.
  - timeRangepayment.common.TimeRange.inrequired
    Description
    The time range for the interval.
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
  - meterUsagespayment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.in[]required
    Description
    The list of meter usages for product items.
    - meterApiNamestringrequired
      Description
      name of the meter API.
    - dimensionKeysstring[]required
      Description
      The keys for required dimensions.
    - variantUsagespayment.pricing.customer.quote.CustomerCommitmentVariantUsage.in[]required
      Description
      The usages for item variants.
      - dimensionValuesstring[]required
        Description
        The item variant values for the dimensions.
      - usageValuenumberrequired
        Description
        The usage for the
      - usageFrequencypayment.pricing.customer.quote.CustomerCommitmentUsageFrequency.inrequired
        Description
        The frequency for each item variant usage.
  - promotionspayment.pricing.customer.quote.CustomerCommitmentPromotion.in[]required
    Description
    The promotions for the interval.
    - existingPromotionIdstringrequired
      Description
      The unique ID for the customer.
    - inlinePromotionpayment.pricing.promotions.Promotion.inrequired
      Description
      The unique ID for the product plan.
      - payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in
        idstringrequired
        Description
        Unique id for the promotion.
        typestring
        Description
        Promotion type.
        Default
        absolute_product_automatic_promotion
        promotionNamestringrequired
        Description
        Display name for the promotion.
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.in
        dimensionConstraintMapmap<string, string>
        customerTagsmap<string, string>
        isHiddenboolean
        discountnumber
        totalMaxDiscountnumber
        targetProductIdstring
      - payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in
        idstringrequired
        Description
        Unique id for the promotion.
        typestring
        Description
        Promotion type.
        Default
        absolute_product_item_automatic_promotion
        promotionNamestringrequired
        Description
        Display name for the promotion.
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.in
        Max depth limit reached
        dimensionConstraintMapmap<string, string>
        customerTagsmap<string, string>
        isHiddenboolean
        discountnumber
        totalMaxDiscountnumber
        targetProductItemIdstring
        isRegExboolean
        Description
        Determines whether to use regular expression matching for dimension values.
      - payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.FreeTrialPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.GenericItemPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.GenericProductPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in
        Max depth limit reached
      - payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in
        Max depth limit reached

Responses

200Successful request

payment.pricing.customer.quote.CustomerCommitmentUsageQuoteResponse.out
- usageQuoteRequestpayment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.outrequired
  Description
  The request for usage quote.
  - customerIdstringrequired
    Description
    The unique ID for the customer.
  - customProductPlanGeneratorpayment.pricing.plans.generators.PlanGenerator.out
    Description
    A custom product plan for the calculator.
    - payment.pricing.plans.generators.CustomPlanGenerator.out
      - typestring
        Description
        Type of template, automatically populated.
        Default
        custom_pricing_plan
      - idstringrequired
        Description
        Id associated with the plan.
      - billingPeriodpayment.pricing.BillingPeriod.outrequired
        Description
        Billing period of the plan: how often an invoice is generated.
        intervalpayment.pricing.BillingPeriodInterval.out
        intervalsCountinteger<int32>
      - planLevelFreeTiernumber
        Description
        Amount that user can use for free without paying on a plan level.
      - invoiceBasedFeeIdsstring[]
        Description
        A set of fee ids that can calculate an invoice's cost in a custom way.
      - planMinimumPaymentnumber
        Description
        A minimum payment for the entire plan.
      - minimumPaymentGranularitypayment.pricing.price.UsageGranularity.out
        Description
        Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.
      - planNamestringrequired
        Description
        Name of the plan. Useful for displaying to users.
      - descriptionstring
        Description
        Description of the plan. Useful for displaying to users.
      - feeMapmap<string, payment.pricing.ProductPlanFee.out>
        Description
        Fee Id to fee that maps to product plan fee.
      - entitlementspayment.pricing.Entitlements.Entitlement.out[]
        Description
        A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
        idstringrequired
        Description
        Id for the Entitlement.
        labelstring
        Description
        Label for the Entitlement.
        apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
      - lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the plan can be modified or not.
      - isDefaultboolean
        Description
        Indicates if the plan is the default plan for users.
      - successorPlanIdstring
        Description
        Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
      - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
        Description
        Successor plan transition: whether to wait for end of billing cycle or not.
      - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.out
        Description
        Rules for the prepaid
        planFixedFeeIdsToPrepaystring[]
        planRecurringPrepaidAmountnumber
        Description
        Recurring prepaid to purchase on every billing period on a plan level.
        productItemRecurringPrepaidAmountpayment.pricing.prepaid.PrepaidProductItem.out[]
        Description
        Recurring prepaid to purchase on every billing period on a product item level.
        productItemIdstring
        Description
        Product item id that is associated with amount of prepaid.
        prepaidAmountnumber
        Description
        Prepaid amount that is associated with the object.
        walletMinPrepaidAvailablenumber
        Description
        Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.
        productItemMinPrepaidAvailablemap<string, number>
        Description
        Key: product item id. Minimum amount that prepaid cards for a product item should hold. If it's below, Amberflo will automatically purchase more.
      - planCurrencystring
        Example
        USD
        Description
        The customized currency for the plan in ISO 4217 format.
      - priceGeneratorspayment.pricing.price.generators.PriceGenerator.out[]required
        Description
        List of price generators to use in the plan. Can be any price generator.
        payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out
        dimensionKeysstring[]required
        Description
        Keys associated with dimension values.
        idstring
        Description
        Id associated with the price.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the meter can be modified or not.
        Max depth limit reached
        scalarnumber
        Description
        Scalar value used to scale usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.out[]
        Description
        Scalars for scaling usage by dimensions
        Max depth limit reached
        priceTierspayment.pricing.price.generators.TieredPriceGroupInfo.out[]required
        Description
        Price for each tier. Leaf node type must be LeafNode
        Max depth limit reached
        allowPartialBatchboolean
        Description
        Count tier rates in cents.
        typestring
        Description
        Type of template, automatically populated.
        Default
        cost_plus_dimension
        payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.FlatRatePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.TieredSeatBasedGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
      - invoiceBasedFeespayment.pricing.invoice_based_fees.InvoiceBasedFee.out[]
        Description
        The service fees for the invoice.
        payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out
        typestring
        Default
        constant_invoice_ratio_fee
        productIdstring
        idstring
        namestring
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Max depth limit reached
        lastUpdateTimeInMillisinteger<int64>
        percentsOfInvoicenumber
        minimumFeePerFullCyclenumber
    - payment.pricing.plans.generators.FlatRatePlanGenerator.out
      - idstringrequired
        Description
        Id associated with the plan.
      - billingPeriodpayment.pricing.BillingPeriod.outrequired
        Description
        Billing period of the plan: how often an invoice is generated.
        intervalpayment.pricing.BillingPeriodInterval.out
        Max depth limit reached
        intervalsCountinteger<int32>
      - planNamestringrequired
        Description
        Name of the plan. Useful for displaying to users.
      - priceGeneratorspayment.pricing.price.generators.FlatRatePriceGenerator.out[]required
        Description
        List of price generators to use in the plan. Must be strictly flat rate.
        idstringrequired
        Description
        Id associated with the price.
        flatRatenumberrequired
        Description
        Amount intended to be charged.
        productItemIdstringrequired
        Description
        Product item id associated with the price.
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the meter can be modified or not.
        Max depth limit reached
        productItemInvoiceLabelstring
        Description
        Optional product item invoice label. Used for renaming invoice items.
        productItemPriceNamestring
        Description
        Name of the price machine. Useful for displaying to users.
        scalarnumber
        Description
        Optional scalar for scaling usage
        dimensionalScalarspayment.pricing.price.DimensionalScalar.out[]
        Description
        Optional scalars for scaling usage by dimensions
        Max depth limit reached
        usageTransformerpayment.pricing.UsageTransformer.out
        Description
        Optional usage transformer. May include just transformer id if the transformer already exists.
        Max depth limit reached
        typestring
        Description
        Type of template, automatically populated.
        Default
        flat_rate
      - descriptionstring
        Description
        Description of the plan. Useful for displaying to users.
      - invoiceBasedFeeIdsstring[]
        Description
        A set of fee ids that can calculate an invoice's cost in a custom way.
      - isDefaultboolean
        Description
        Indicates if the plan is the default plan for users.
      - lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the plan can be modified or not.
      - planLevelFreeTiernumber
        Description
        Amount that user can use for free without paying on a plan level.
      - successorPlanIdstring
        Description
        Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
      - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
        Description
        Successor plan transition: whether to wait for end of billing cycle or not.
      - entitlementspayment.pricing.Entitlements.Entitlement.out[]
        Description
        A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
        idstringrequired
        Description
        Id for the Entitlement.
        labelstring
        Description
        Label for the Entitlement.
        apiNamestringrequired
        Description
        User-defined API Name for the Entitlement.
      - typestring
        Description
        Type of template, automatically populated.
        Default
        flat_rate
    - payment.pricing.plans.generators.PayAndGoPlanGenerator.out
      - idstringrequired
        Description
        Id associated with the plan.
      - billingPeriodpayment.pricing.BillingPeriod.outrequired
        Description
        Billing period of the plan: how often an invoice is generated.
        Max depth limit reached
      - planNamestringrequired
        Description
        Name of the plan. Useful for displaying to users.
      - prepaidBuyingRulespayment.pricing.prepaid.PlanPrepaidBuyingRules.outrequired
        Description
        Pay and Go prepaid credit purchasing information.
        Max depth limit reached
      - priceGeneratorspayment.pricing.price.generators.UsageBasedPriceGenerator.out[]required
        Description
        List of price generators to use in the plan. Must be usage-based.
        payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out
        Max depth limit reached
        payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out
        Max depth limit reached
      - descriptionstring
        Description
        Description of the plan. Useful for displaying to users.
      - feeMapmap<string, payment.pricing.ProductPlanFee.out>
        Description
        Fixed fees to attach to product plan.
      - invoiceBasedFeeIdsstring[]
        Description
        A set of ids for invoice based fees that are added to the invoice.
      - isDefaultboolean
        Description
        Indicates if the plan is the default plan for users.
      - lockingStatuscom.amberflo.service.common.LockingStatus.out
        Description
        Indicates if the plan can be modified or not.
        Max depth limit reached
      - planLevelFreeTiernumber
        Description
        Amount that user can use for free without paying on a plan level.
      - successorPlanIdstring
        Description
        Indicates if the plan has a successor. Gives the option to automatically assign a new plan for a given plan once current plan is deprecated.
      - transitionStrategypayment.pricing.SuccessorPlanTransitionStrategy.out
        Description
        Successor plan transition: whether to wait for end of billing cycle or not.
        Max depth limit reached
      - entitlementspayment.pricing.Entitlements.Entitlement.out[]
        Description
        A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.
        Max depth limit reached
      - typestring
        Description
        Type of template, automatically populated.
        Default
        pay_and_go
    - payment.pricing.plans.generators.UsageBasedPlanGenerator.out
      - Max depth limit reached
    - payment.pricing.plans.generators.SeatBasedPlanGenerator.out
      - Max depth limit reached
    - payment.pricing.plans.generators.SubscriptionPlanGenerator.out
      - Max depth limit reached
  - productPlanIdstring
    Description
    The unique ID for the product plan.
  - intervalUsagespayment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.out[]required
    Description
    The list of intervals.
    - timeRangepayment.common.TimeRange.outrequired
      Description
      The time range for the interval.
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - meterUsagespayment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.out[]required
      Description
      The list of meter usages for product items.
      - meterApiNamestringrequired
        Description
        name of the meter API.
      - dimensionKeysstring[]required
        Description
        The keys for required dimensions.
      - variantUsagespayment.pricing.customer.quote.CustomerCommitmentVariantUsage.out[]required
        Description
        The usages for item variants.
        dimensionValuesstring[]required
        Description
        The item variant values for the dimensions.
        usageValuenumberrequired
        Description
        The usage for the
        usageFrequencypayment.pricing.customer.quote.CustomerCommitmentUsageFrequency.outrequired
        Description
        The frequency for each item variant usage.
    - promotionspayment.pricing.customer.quote.CustomerCommitmentPromotion.out[]required
      Description
      The promotions for the interval.
      - existingPromotionIdstringrequired
        Description
        The unique ID for the customer.
      - inlinePromotionpayment.pricing.promotions.Promotion.outrequired
        Description
        The unique ID for the product plan.
        payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out
        idstringrequired
        Description
        Unique id for the promotion.
        typestring
        Description
        Promotion type.
        Default
        absolute_product_automatic_promotion
        promotionNamestringrequired
        Description
        Display name for the promotion.
        descriptionstring
        lockingStatuscom.amberflo.service.common.LockingStatus.out
        Max depth limit reached
        lastUpdateTimeInMillisinteger<int64>
        Description
        Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
        dimensionConstraintMapmap<string, string>
        customerTagsmap<string, string>
        isHiddenboolean
        discountnumber
        totalMaxDiscountnumber
        targetProductIdstring
        payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.FreeTrialPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.GenericItemPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.GenericProductPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out
        Max depth limit reached
        payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out
        Max depth limit reached
- intervalQuotespayment.pricing.customer.quote.CustomerCommitmentIntervalUsageResponse.out[]required
  - itemQuotespayment.pricing.customer.quote.CustomerCommitmentItemUsageResponse.out[]required
    Description
    The time range for the interval.
    - itemQuotepayment.pricing.customer.quote.CustomerCommitmentPriceQuote.outrequired
      Description
      The quote cost for the item.
      - quotedUsageCostBeforeDiscountnumberrequired
        Description
        The CPQ usage cost before applying discount.
      - quotedUsageCostDiscountnumberrequired
        Description
        The discount for the CPQ usage cost.
      - quotedUsageCostAfterDiscountnumberrequired
        Description
        The CPQ usage cost after applying discount.
      - quotedFixedCostBeforeDiscountnumberrequired
        Description
        The CPQ fixed cost before applying discount.
      - quotedFixedCostDiscountnumberrequired
        Description
        The discount for the CPQ fixed cost.
      - quotedFixedCostAfterDiscountnumberrequired
        Description
        The CPQ fixed cost after applying discount.
      - quotedCostBeforeDiscountnumberrequired
        Description
        The total CPQ cost before applying discount.
      - quotedCostDiscountnumberrequired
        Description
        The discount for the total CPQ cost.
      - quotedCostAfterDiscountnumberrequired
        Description
        The total CPQ cost after applying discount.
      - totalMeterUnitsnumberrequired
        Description
        The total units for the CPQ meter.
  - intervalQuotepayment.pricing.customer.quote.CustomerCommitmentPriceQuote.outrequired
    Description
    The total quote cost details for the interval usage.
    - quotedUsageCostBeforeDiscountnumberrequired
      Description
      The CPQ usage cost before applying discount.
    - quotedUsageCostDiscountnumberrequired
      Description
      The discount for the CPQ usage cost.
    - quotedUsageCostAfterDiscountnumberrequired
      Description
      The CPQ usage cost after applying discount.
    - quotedFixedCostBeforeDiscountnumberrequired
      Description
      The CPQ fixed cost before applying discount.
    - quotedFixedCostDiscountnumberrequired
      Description
      The discount for the CPQ fixed cost.
    - quotedFixedCostAfterDiscountnumberrequired
      Description
      The CPQ fixed cost after applying discount.
    - quotedCostBeforeDiscountnumberrequired
      Description
      The total CPQ cost before applying discount.
    - quotedCostDiscountnumberrequired
      Description
      The discount for the total CPQ cost.
    - quotedCostAfterDiscountnumberrequired
      Description
      The total CPQ cost after applying discount.
    - totalMeterUnitsnumberrequired
      Description
      The total units for the CPQ meter.
- totalQuotepayment.pricing.customer.quote.CustomerCommitmentPriceQuote.outrequired
  Description
  The total quote cost details.
  - quotedUsageCostBeforeDiscountnumberrequired
    Description
    The CPQ usage cost before applying discount.
  - quotedUsageCostDiscountnumberrequired
    Description
    The discount for the CPQ usage cost.
  - quotedUsageCostAfterDiscountnumberrequired
    Description
    The CPQ usage cost after applying discount.
  - quotedFixedCostBeforeDiscountnumberrequired
    Description
    The CPQ fixed cost before applying discount.
  - quotedFixedCostDiscountnumberrequired
    Description
    The discount for the CPQ fixed cost.
  - quotedFixedCostAfterDiscountnumberrequired
    Description
    The CPQ fixed cost after applying discount.
  - quotedCostBeforeDiscountnumberrequired
    Description
    The total CPQ cost before applying discount.
  - quotedCostDiscountnumberrequired
    Description
    The discount for the total CPQ cost.
  - quotedCostAfterDiscountnumberrequired
    Description
    The total CPQ cost after applying discount.
  - totalMeterUnitsnumberrequired
    Description
    The total units for the CPQ meter.

curl

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customerId": "",
     "customProductPlanGenerator": {
     "type": "custom_pricing_plan",
     "id": "",
     "billingPeriod": {},
     "planName": "",
     "entitlements": [
     {
     "id": "",
     "apiName": ""
     }
     ],
     "priceGenerators": {
     "dimensionKeys": [],
     "productItemId": "",
     "priceTiers": [
     {
     "leafNodeType": ""
     }
     ],
     "type": "cost_plus_dimension"
     },
     "invoiceBasedFees": {
     "type": "constant_invoice_ratio_fee"
     }
     },
     "intervalUsages": [
     {
     "timeRange": {},
     "meterUsages": [
     {
     "meterApiName": "",
     "dimensionKeys": [],
     "variantUsages": [
     {
     "dimensionValues": [],
     "usageValue": "",
     "usageFrequency": ""
     }
     ]
     }
     ],
     "promotions": [
     {
     "existingPromotionId": "",
     "inlinePromotion": {
     "id": "",
     "type": "absolute_product_automatic_promotion",
     "promotionName": ""
     }
     }
     ]
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "customerId": "",
   "customProductPlanGenerator": {
      "type": "custom_pricing_plan",
      "id": "",
      "billingPeriod": {},
      "planName": "",
      "entitlements": [
         {
            "id": "",
            "apiName": ""
         }
      ],
      "priceGenerators": {
         "dimensionKeys": [],
         "productItemId": "",
         "priceTiers": [
            {
               "leafNodeType": ""
            }
         ],
         "type": "cost_plus_dimension"
      },
      "invoiceBasedFees": {
         "type": "constant_invoice_ratio_fee"
      }
   },
   "intervalUsages": [
      {
         "timeRange": {},
         "meterUsages": [
            {
               "meterApiName": "",
               "dimensionKeys": [],
               "variantUsages": [
                  {
                     "dimensionValues": [],
                     "usageValue": "",
                     "usageFrequency": ""
                  }
               ]
            }
         ],
         "promotions": [
            {
               "existingPromotionId": "",
               "inlinePromotion": {
                  "id": "",
                  "type": "absolute_product_automatic_promotion",
                  "promotionName": ""
               }
            }
         ]
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "customerId": "",
   "customProductPlanGenerator": {
      "type": "custom_pricing_plan",
      "id": "",
      "billingPeriod": {},
      "planName": "",
      "entitlements": [
         {
            "id": "",
            "apiName": ""
         }
      ],
      "priceGenerators": {
         "dimensionKeys": [],
         "productItemId": "",
         "priceTiers": [
            {
               "leafNodeType": ""
            }
         ],
         "type": "cost_plus_dimension"
      },
      "invoiceBasedFees": {
         "type": "constant_invoice_ratio_fee"
      }
   },
   "intervalUsages": [
      {
         "timeRange": {},
         "meterUsages": [
            {
               "meterApiName": "",
               "dimensionKeys": [],
               "variantUsages": [
                  {
                     "dimensionValues": [],
                     "usageValue": "",
                     "usageFrequency": ""
                  }
               ]
            }
         ],
         "promotions": [
            {
               "existingPromotionId": "",
               "inlinePromotion": {
                  "id": "",
                  "type": "absolute_product_automatic_promotion",
                  "promotionName": ""
               }
            }
         ]
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote"

payload = json.dumps({
   "customerId": "",
   "customProductPlanGenerator": {
      "type": "custom_pricing_plan",
      "id": "",
      "billingPeriod": {},
      "planName": "",
      "entitlements": [
         {
            "id": "",
            "apiName": ""
         }
      ],
      "priceGenerators": {
         "dimensionKeys": [],
         "productItemId": "",
         "priceTiers": [
            {
               "leafNodeType": ""
            }
         ],
         "type": "cost_plus_dimension"
      },
      "invoiceBasedFees": {
         "type": "constant_invoice_ratio_fee"
      }
   },
   "intervalUsages": [
      {
         "timeRange": {},
         "meterUsages": [
            {
               "meterApiName": "",
               "dimensionKeys": [],
               "variantUsages": [
                  {
                     "dimensionValues": [],
                     "usageValue": "",
                     "usageFrequency": ""
                  }
               ]
            }
         ],
         "promotions": [
            {
               "existingPromotionId": "",
               "inlinePromotion": {
                  "id": "",
                  "type": "absolute_product_automatic_promotion",
                  "promotionName": ""
               }
            }
         ]
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "usageQuoteRequest": {
    "customerId": "",
    "customProductPlanGenerator": {},
    "productPlanId": "",
    "intervalUsages": [
      {
        "timeRange": {
          "startTimeInSeconds": "",
          "endTimeInSeconds": ""
        },
        "meterUsages": [
          {
            "meterApiName": "",
            "dimensionKeys": [
              ""
            ],
            "variantUsages": [
              {
                "dimensionValues": [
                  ""
                ],
                "usageValue": 0,
                "usageFrequency": ""
              }
            ]
          }
        ],
        "promotions": [
          {
            "existingPromotionId": "",
            "inlinePromotion": {}
          }
        ]
      }
    ]
  },
  "intervalQuotes": [
    {
      "itemQuotes": [
        {
          "itemQuote": {
            "quotedUsageCostBeforeDiscount": 0,
            "quotedUsageCostDiscount": 0,
            "quotedUsageCostAfterDiscount": 0,
            "quotedFixedCostBeforeDiscount": 0,
            "quotedFixedCostDiscount": 0,
            "quotedFixedCostAfterDiscount": 0,
            "quotedCostBeforeDiscount": 0,
            "quotedCostDiscount": 0,
            "quotedCostAfterDiscount": 0,
            "totalMeterUnits": 0
          }
        }
      ],
      "intervalQuote": {
        "quotedUsageCostBeforeDiscount": 0,
        "quotedUsageCostDiscount": 0,
        "quotedUsageCostAfterDiscount": 0,
        "quotedFixedCostBeforeDiscount": 0,
        "quotedFixedCostDiscount": 0,
        "quotedFixedCostAfterDiscount": 0,
        "quotedCostBeforeDiscount": 0,
        "quotedCostDiscount": 0,
        "quotedCostAfterDiscount": 0,
        "totalMeterUnits": 0
      }
    }
  ],
  "totalQuote": {
    "quotedUsageCostBeforeDiscount": 0,
    "quotedUsageCostDiscount": 0,
    "quotedUsageCostAfterDiscount": 0,
    "quotedFixedCostBeforeDiscount": 0,
    "quotedFixedCostDiscount": 0,
    "quotedFixedCostAfterDiscount": 0,
    "quotedCostBeforeDiscount": 0,
    "quotedCostDiscount": 0,
    "quotedCostAfterDiscount": 0,
    "totalMeterUnits": 0
  }
}