--- title: Quote the CPQ Usage Price slug: amberflo-api/quote-the-cpq-usage-price docTags: createdAt: 2024-11-07T15:10:16.975Z --- { "id": "Br8MijqE7N1DI7ZWNnQzB", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote" } ], "name": "Quote the CPQ Usage Price", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.in", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "customProductPlanGenerator", "kind": "optional", "type": "object", "description": "A custom product plan for the calculator.", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PlanGenerator.in", "customType": "payment.pricing.plans.generators.PlanGenerator.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.plans.generators.CustomPlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.CustomPlanGenerator.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "custom_pricing_plan" }, { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.in", "customType": "payment.pricing.price.UsageGranularity.in", "schema": [] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fee Id to fee that maps to product plan fee.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.in", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.in", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.in", "customType": "payment.pricing.prepaid.PrepaidProductItem.in[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item id that is associated with amount of prepaid.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid amount that is associated with the object.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Can be any price generator.", "modelRef": "#/components/schemas/payment.pricing.price.generators.PriceGenerator.in", "customType": "payment.pricing.price.generators.PriceGenerator.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.CostPlusDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusDimensionPriceGenerator.in", "schema": [ { "name": "dimensionKeys", "kind": "required", "type": "array", "description": "Keys associated with dimension values.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id associated with the price.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item id associated with the price.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional product item invoice label. Used for renaming invoice items.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Name of the price machine. Useful for displaying to users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the meter can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Scalar value used to scale usage", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Scalars for scaling usage by dimensions", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Price for each tier. Leaf node type must be LeafNode", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredPriceGroupInfo.in", "customType": "payment.pricing.price.generators.TieredPriceGroupInfo.in[]", "schema": [ { "name": "dimensionValues", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTiers", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.in", "customType": "payment.pricing.price.PriceTier.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "leafNodeType", "kind": "required", "type": "string", "example": "" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Count tier rates in cents.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "cost_plus_dimension" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.in", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Id associated with the price.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item id associated with the price.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional product item invoice label. Used for renaming invoice items.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Name of the price machine. Useful for displaying to users.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Scalar value used to scale usage", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Scalars for scaling usage by dimensions", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Price for each tier.", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.in", "customType": "payment.pricing.price.PriceTier.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Count tier rates in cents.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "cost_plus_no_dimension" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.in", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "constant_invoice_ratio_fee" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "percentsOfInvoice", "kind": "optional", "type": "number", "example": "" }, { "name": "minimumFeePerFullCycle", "kind": "optional", "type": "number", "example": "" } ] } ] } ] }, { "name": "payment.pricing.plans.generators.FlatRatePlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.FlatRatePlanGenerator.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "array", "description": "List of price generators to use in the plan. Must be strictly flat rate.", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.in", "customType": "payment.pricing.price.generators.FlatRatePriceGenerator.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the price.", "example": "" }, { "name": "flatRate", "kind": "required", "type": "number", "description": "Amount intended to be charged.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item id associated with the price.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the meter can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional product item invoice label. Used for renaming invoice items.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Name of the price machine. Useful for displaying to users.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Optional scalar for scaling usage", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Optional scalars for scaling usage by dimensions", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usageTransformer", "kind": "optional", "type": "object", "description": "Optional usage transformer. May include just transformer id if the transformer already exists.", "modelRef": "#/components/schemas/payment.pricing.UsageTransformer.in", "customType": "payment.pricing.UsageTransformer.in", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for a particular usage transformer.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name given to the usage transformer.", "example": "" }, { "name": "transformUsageDimensionName", "kind": "optional", "type": "string", "description": "Name of the dimension used to transform / scale usage.", "example": "" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item id associated with the usage transformer.", "example": "" }, { "name": "dimensionsInterpolations", "kind": "optional", "type": "object", "description": "List of dimension interpolations, used to derive new dimensions and their values.", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.in", "customType": "com.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.in", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "com.amberflo.service.common.dimensions_interpolation.TableInterpolation.in", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.TableInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.in", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredDimensions", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "prepaidBuyingRules", "kind": "required", "type": "object", "description": "Pay and Go prepaid credit purchasing information.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.in", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.in", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.in", "customType": "payment.pricing.prepaid.PrepaidProductItem.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Must be usage-based.", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedPriceGenerator.in", "customType": "payment.pricing.price.generators.UsageBasedPriceGenerator.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fixed fees to attach to product plan.", "example": "", "customType": "map", "schema": [] }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of ids for invoice based fees that are added to the invoice.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "pay_and_go" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Must be usage-based.", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedPriceGenerator.in", "customType": "payment.pricing.price.generators.UsageBasedPriceGenerator.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "pure_usage_based" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "productPlanId", "kind": "optional", "type": "string", "description": "The unique ID for the product plan.", "example": "" }, { "name": "intervalUsages", "kind": "required", "type": "array", "description": "The list of intervals.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.in", "customType": "payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.in[]", "schema": [ { "name": "timeRange", "kind": "required", "type": "object", "description": "The time range for the interval.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "meterUsages", "kind": "required", "type": "array", "description": "The list of meter usages for product items.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.in", "customType": "payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.in[]", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "name of the meter API.", "example": "" }, { "name": "dimensionKeys", "kind": "required", "type": "array", "description": "The keys for required dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "variantUsages", "kind": "required", "type": "array", "description": "The usages for item variants.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentVariantUsage.in", "customType": "payment.pricing.customer.quote.CustomerCommitmentVariantUsage.in[]", "schema": [ { "name": "dimensionValues", "kind": "required", "type": "array", "description": "The item variant values for the dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The usage for the", "example": "" }, { "name": "usageFrequency", "kind": "required", "type": "string", "description": "The frequency for each item variant usage.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.in", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.in", "schema": [] } ] } ] }, { "name": "promotions", "kind": "required", "type": "array", "description": "The promotions for the interval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPromotion.in", "customType": "payment.pricing.customer.quote.CustomerCommitmentPromotion.in[]", "schema": [ { "name": "existingPromotionId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "inlinePromotion", "kind": "required", "type": "object", "description": "The unique ID for the product plan.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.in", "customType": "payment.pricing.promotions.Promotion.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] } ], "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageQuoteResponse.out", "schema": [ { "name": "usageQuoteRequest", "kind": "required", "type": "object", "description": "The request for usage quote.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageQuoteRequest.out", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "customProductPlanGenerator", "kind": "optional", "type": "object", "description": "A custom product plan for the calculator.", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PlanGenerator.out", "customType": "payment.pricing.plans.generators.PlanGenerator.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.plans.generators.CustomPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.CustomPlanGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "custom_pricing_plan" }, { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "A minimum payment for the entire plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Determines the granularity of the payment. only 'hourly' and 'entire_invoice_period' are allowed, currently.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fee Id to fee that maps to product plan fee.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules for the prepaid", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid to purchase on every billing period on a plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid to purchase on every billing period on a product item level.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.out", "customType": "payment.pricing.prepaid.PrepaidProductItem.out[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item id that is associated with amount of prepaid.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid amount that is associated with the object.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum amount that the prepaid wallet should hold. If it's below, Amberflo will automatically purchase more.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "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.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Can be any price generator.", "modelRef": "#/components/schemas/payment.pricing.price.generators.PriceGenerator.out", "customType": "payment.pricing.price.generators.PriceGenerator.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusDimensionPriceGenerator.out", "schema": [ { "name": "dimensionKeys", "kind": "required", "type": "array", "description": "Keys associated with dimension values.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id associated with the price.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item id associated with the price.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional product item invoice label. Used for renaming invoice items.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Name of the price machine. Useful for displaying to users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the meter can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Scalar value used to scale usage", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Scalars for scaling usage by dimensions", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.out", "customType": "payment.pricing.price.DimensionalScalar.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Price for each tier. Leaf node type must be LeafNode", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredPriceGroupInfo.out", "customType": "payment.pricing.price.generators.TieredPriceGroupInfo.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Count tier rates in cents.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "cost_plus_dimension" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.out", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "constant_invoice_ratio_fee" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "percentsOfInvoice", "kind": "optional", "type": "number", "example": "" }, { "name": "minimumFeePerFullCycle", "kind": "optional", "type": "number", "example": "" } ] } ] } ] }, { "name": "payment.pricing.plans.generators.FlatRatePlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.FlatRatePlanGenerator.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "array", "description": "List of price generators to use in the plan. Must be strictly flat rate.", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "customType": "payment.pricing.price.generators.FlatRatePriceGenerator.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the price.", "example": "" }, { "name": "flatRate", "kind": "required", "type": "number", "description": "Amount intended to be charged.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item id associated with the price.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the meter can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional product item invoice label. Used for renaming invoice items.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Name of the price machine. Useful for displaying to users.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Optional scalar for scaling usage", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Optional scalars for scaling usage by dimensions", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.out", "customType": "payment.pricing.price.DimensionalScalar.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "usageTransformer", "kind": "optional", "type": "object", "description": "Optional usage transformer. May include just transformer id if the transformer already exists.", "modelRef": "#/components/schemas/payment.pricing.UsageTransformer.out", "customType": "payment.pricing.UsageTransformer.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of fee ids that can calculate an invoice's cost in a custom way.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id for the Entitlement.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the Entitlement.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API Name for the Entitlement.", "example": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "flat_rate" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Id associated with the plan.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing period of the plan: how often an invoice is generated.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Name of the plan. Useful for displaying to users.", "example": "" }, { "name": "prepaidBuyingRules", "kind": "required", "type": "object", "description": "Pay and Go prepaid credit purchasing information.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators to use in the plan. Must be usage-based.", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedPriceGenerator.out", "customType": "payment.pricing.price.generators.UsageBasedPriceGenerator.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the plan. Useful for displaying to users.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Fixed fees to attach to product plan.", "example": "", "customType": "map", "schema": [] }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "A set of ids for invoice based fees that are added to the invoice.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if the plan is the default plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Amount that user can use for free without paying on a plan level.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "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.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Successor plan transition: whether to wait for end of billing cycle or not.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "A list of entitlements: Entitlement is a feature flag for a specified entitlement id or an api name.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.out", "customType": "payment.pricing.Entitlements.Entitlement.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of template, automatically populated.", "example": "", "default": "pay_and_go" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "productPlanId", "kind": "optional", "type": "string", "description": "The unique ID for the product plan.", "example": "" }, { "name": "intervalUsages", "kind": "required", "type": "array", "description": "The list of intervals.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.out[]", "schema": [ { "name": "timeRange", "kind": "required", "type": "object", "description": "The time range for the interval.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "meterUsages", "kind": "required", "type": "array", "description": "The list of meter usages for product items.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.out[]", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "name of the meter API.", "example": "" }, { "name": "dimensionKeys", "kind": "required", "type": "array", "description": "The keys for required dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "variantUsages", "kind": "required", "type": "array", "description": "The usages for item variants.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentVariantUsage.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentVariantUsage.out[]", "schema": [ { "name": "dimensionValues", "kind": "required", "type": "array", "description": "The item variant values for the dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The usage for the", "example": "" }, { "name": "usageFrequency", "kind": "required", "type": "string", "description": "The frequency for each item variant usage.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.out", "schema": [] } ] } ] }, { "name": "promotions", "kind": "required", "type": "array", "description": "The promotions for the interval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPromotion.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPromotion.out[]", "schema": [ { "name": "existingPromotionId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "inlinePromotion", "kind": "required", "type": "object", "description": "The unique ID for the product plan.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] } ] }, { "name": "intervalQuotes", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentIntervalUsageResponse.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentIntervalUsageResponse.out[]", "schema": [ { "name": "itemQuotes", "kind": "required", "type": "array", "description": "The time range for the interval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentItemUsageResponse.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentItemUsageResponse.out[]", "schema": [ { "name": "itemQuote", "kind": "required", "type": "object", "description": "The quote cost for the item.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] } ] }, { "name": "intervalQuote", "kind": "required", "type": "object", "description": "The total quote cost details for the interval usage.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] } ] }, { "name": "totalQuote", "kind": "required", "type": "object", "description": "The total quote cost details.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] } ], "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageQuoteResponse.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "rn6m5y_A7Df_JTxGBfADL", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"customerId\": \"\",\n \"customProductPlanGenerator\": {\n \"type\": \"custom_pricing_plan\",\n \"id\": \"\",\n \"billingPeriod\": {},\n \"planName\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"priceGenerators\": {\n \"dimensionKeys\": [],\n \"productItemId\": \"\",\n \"priceTiers\": [\n {\n \"leafNodeType\": \"\"\n }\n ],\n \"type\": \"cost_plus_dimension\"\n },\n \"invoiceBasedFees\": {\n \"type\": \"constant_invoice_ratio_fee\"\n }\n },\n \"intervalUsages\": [\n {\n \"timeRange\": {},\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [],\n \"variantUsages\": [\n {\n \"dimensionValues\": [],\n \"usageValue\": \"\",\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n }\n ]\n }\n ]\n }'" }, { "id": "6eBrbHoNQjQgbmVZDcCki", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"customerId\": \"\",\n \"customProductPlanGenerator\": {\n \"type\": \"custom_pricing_plan\",\n \"id\": \"\",\n \"billingPeriod\": {},\n \"planName\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"priceGenerators\": {\n \"dimensionKeys\": [],\n \"productItemId\": \"\",\n \"priceTiers\": [\n {\n \"leafNodeType\": \"\"\n }\n ],\n \"type\": \"cost_plus_dimension\"\n },\n \"invoiceBasedFees\": {\n \"type\": \"constant_invoice_ratio_fee\"\n }\n },\n \"intervalUsages\": [\n {\n \"timeRange\": {},\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [],\n \"variantUsages\": [\n {\n \"dimensionValues\": [],\n \"usageValue\": \"\",\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n }\n ]\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "IXRF8BEAfla3r-BE2F-YF", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"customerId\": \"\",\n \"customProductPlanGenerator\": {\n \"type\": \"custom_pricing_plan\",\n \"id\": \"\",\n \"billingPeriod\": {},\n \"planName\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"priceGenerators\": {\n \"dimensionKeys\": [],\n \"productItemId\": \"\",\n \"priceTiers\": [\n {\n \"leafNodeType\": \"\"\n }\n ],\n \"type\": \"cost_plus_dimension\"\n },\n \"invoiceBasedFees\": {\n \"type\": \"constant_invoice_ratio_fee\"\n }\n },\n \"intervalUsages\": [\n {\n \"timeRange\": {},\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [],\n \"variantUsages\": [\n {\n \"dimensionValues\": [],\n \"usageValue\": \"\",\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n }\n ]\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "8fb1abWCmrHgLFpsc2i_f", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment-quote\"\n\npayload = json.dumps({\n \"customerId\": \"\",\n \"customProductPlanGenerator\": {\n \"type\": \"custom_pricing_plan\",\n \"id\": \"\",\n \"billingPeriod\": {},\n \"planName\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"priceGenerators\": {\n \"dimensionKeys\": [],\n \"productItemId\": \"\",\n \"priceTiers\": [\n {\n \"leafNodeType\": \"\"\n }\n ],\n \"type\": \"cost_plus_dimension\"\n },\n \"invoiceBasedFees\": {\n \"type\": \"constant_invoice_ratio_fee\"\n }\n },\n \"intervalUsages\": [\n {\n \"timeRange\": {},\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [],\n \"variantUsages\": [\n {\n \"dimensionValues\": [],\n \"usageValue\": \"\",\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n }\n ]\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "rn6m5y_A7Df_JTxGBfADL" }, "results": { "languages": [ { "id": "1fUOhg0f3WF04PgHjPN2W", "language": "200", "code": "// Successful request\n{\n \"usageQuoteRequest\": {\n \"customerId\": \"\",\n \"customProductPlanGenerator\": {},\n \"productPlanId\": \"\",\n \"intervalUsages\": [\n {\n \"timeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [\n \"\"\n ],\n \"variantUsages\": [\n {\n \"dimensionValues\": [\n \"\"\n ],\n \"usageValue\": 0,\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {}\n }\n ]\n }\n ]\n },\n \"intervalQuotes\": [\n {\n \"itemQuotes\": [\n {\n \"itemQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n }\n }\n ],\n \"intervalQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n }\n }\n ],\n \"totalQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n }\n}" } ], "selectedLanguageId": "1fUOhg0f3WF04PgHjPN2W" } }, "children": [ { "text": "" } ] }