--- title: Create custom pricing plan from template slug: reference/create-custom-pricing-plan-from-template docTags: createdAt: 2025-07-07T18:21:46.977Z --- { "id": "OK-jvDD_651YYmZbPqZjD", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan" } ], "name": "Create custom pricing plan from template", "description": "

Creates a new product pricing plan using a custom plan generator template.\nUse this endpoint to generate pricing plans with specific configurations, pricing tiers, and billing rules.

\n

Use this endpoint to:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "Custom plan generator configuration including pricing rules, tiers, and billing parameters", "customType": "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": "Unique identifier for the pricing plan template.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing frequency determining invoice generation intervals.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "Time interval unit for billing cycle such as day, month, or year", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "description": "Number of intervals in billing cycle with minimum value of 1", "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": "Human-readable plan name for user interface display.", "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": "Unique identifier for the entitlement used in feature flag controls and access validation.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable display name for the entitlement shown in user interfaces and documentation.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API reference name for programmatic entitlement checks and feature gate logic.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "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", "description": "List of fixed fee identifiers that must be prepaid for this plan.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid amount purchased every billing period at plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid amounts purchased every billing period per product item.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.in", "customType": "payment.pricing.prepaid.PrepaidProductItem.in[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item identifier that is associated with the prepaid credit amount.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid credit amount allocated to this specific product item for usage.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum prepaid balance threshold triggering automatic top-up purchases.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "description": "Product item ID to minimum prepaid balance map for automatic purchases.", "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": "Dimension key names used to identify different dimensional variations for cost-plus pricing calculations.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this cost-plus dimensional pricing generator configuration and billing operations.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this cost-plus dimensional pricing generator applies to for billing.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this cost-plus pricing generator displayed in user interfaces and reports.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Lock status indicating whether this cost-plus pricing generator configuration can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Numerical multiplier applied to usage values before cost-plus pricing calculations and tier evaluations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Dimension-specific multipliers applied to usage values based on dimensional characteristics for cost-plus pricing.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Map of dimension name value pairs that must match for scalar to apply.", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Positive multiplier value applied to usage when dimension constraints are satisfied.", "example": "" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Tiered pricing structure defining cost-plus rates and thresholds for different usage volume ranges.", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredPriceGroupInfo.in", "customType": "payment.pricing.price.generators.TieredPriceGroupInfo.in[]", "schema": [ { "name": "dimensionValues", "kind": "optional", "type": "array", "description": "Dimension values that define the specific dimensional combination for this tiered pricing group configuration.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTiers", "kind": "optional", "type": "array", "description": "Tiered pricing structure defining rates and thresholds for different usage volume ranges or billing periods.", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.in", "customType": "payment.pricing.price.PriceTier.in[]", "schema": [ { "name": "startAfterUnit", "kind": "optional", "type": "integer", "description": "Usage threshold where this pricing tier begins after consuming previous tier units.", "example": 0 }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "Number of usage units grouped together in each batch for pricing calculations.", "example": 0 }, { "name": "pricePerBatch", "kind": "optional", "type": "number", "description": "Monetary rate charged per batch with maximum precision of twelve decimal places.", "example": "" } ] }, { "name": "leafNodeType", "kind": "required", "type": "string", "description": "Pricing leaf node type that determines how final price calculations are performed for this tier group.", "example": "" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Flag indicating whether partial batch processing is allowed for cost-plus pricing tier calculations.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for cost-plus dimensional pricing template processing and validation.", "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": "Unique identifier for this cost-plus pricing generator configuration without dimensional variations.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this cost-plus pricing generator applies to for billing operations.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this cost-plus pricing generator displayed in user interfaces and reports.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Numerical multiplier applied to usage values before cost-plus pricing calculations and tier evaluations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Dimension-specific multipliers applied to usage values despite this generator having no primary dimensions.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Map of dimension name value pairs that must match for scalar to apply.", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Positive multiplier value applied to usage when dimension constraints are satisfied.", "example": "" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Tiered pricing structure defining cost-plus rates and thresholds for different usage volume ranges.", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.in", "customType": "payment.pricing.price.PriceTier.in[]", "schema": [ { "name": "startAfterUnit", "kind": "optional", "type": "integer", "description": "Usage threshold where this pricing tier begins after consuming previous tier units.", "example": 0 }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "Number of usage units grouped together in each batch for pricing calculations.", "example": 0 }, { "name": "pricePerBatch", "kind": "optional", "type": "number", "description": "Monetary rate charged per batch with maximum precision of twelve decimal places.", "example": "" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Flag indicating whether partial batch processing is allowed for cost-plus pricing tier calculations.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for cost-plus non-dimensional pricing template processing and validation.", "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": "id", "kind": "required", "type": "string", "description": "Unique identifier for this flat rate pricing generator configuration and billing operations.", "example": "" }, { "name": "flatRate", "kind": "required", "type": "number", "description": "Fixed monetary amount charged regardless of usage volume for flat rate pricing model.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this flat rate pricing generator applies to for billing operations.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Lock status indicating whether this flat rate pricing generator configuration can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this flat rate pricing generator displayed in user interfaces.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Optional numerical multiplier applied to usage values before flat rate pricing calculations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Optional dimension-specific multipliers applied to usage values for flat rate pricing variations.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Map of dimension name value pairs that must match for scalar to apply.", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Positive multiplier value applied to usage when dimension constraints are satisfied.", "example": "" } ] }, { "name": "usageTransformer", "kind": "optional", "type": "object", "description": "Optional usage data transformer configuration for modifying usage before flat rate pricing.", "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/common.dimensions_interpolation.DimensionsInterpolation.in", "customType": "common.dimensions_interpolation.DimensionsInterpolation.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "common.dimensions_interpolation.ListNumericInterpolation.in", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.ListNumericInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "common.dimensions_interpolation.TableInterpolation.in", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.TableInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "common.dimensions_interpolation.TiersInterpolation.in", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.TiersInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredDimensions", "kind": "optional", "type": "array", "description": "Required dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "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": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for flat rate pricing template processing and validation.", "example": "", "default": "flat_rate" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for this flat rate with overages pricing generator configuration and billing.", "example": "" }, { "name": "flatRate", "kind": "required", "type": "number", "description": "Fixed base amount charged before applying tiered overage rates for usage-based calculations.", "example": "" }, { "name": "leafNodeType", "kind": "required", "type": "string", "description": "Pricing leaf node type that determines how overage charges are calculated beyond flat rate.", "example": "" }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Tiered pricing structure defining overage rates and thresholds applied after flat rate base cost.", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.in", "customType": "payment.pricing.price.PriceTier.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this flat rate with overages pricing generator applies to.", "example": "" }, { "name": "groupDimensions", "kind": "optional", "type": "array", "description": "Dimension names used to group invoice line items for flat rate with overages billing.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Lock status indicating whether this flat rate with overages pricing generator can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this flat rate with overages pricing generator displayed in interfaces.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Optional numerical multiplier applied to usage values before flat rate with overages calculations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Optional dimension-specific multipliers applied to usage values for flat rate with overages variations.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "usageTransformer", "kind": "optional", "type": "object", "description": "Optional usage data transformer configuration for modifying usage before flat rate with overages pricing.", "modelRef": "#/components/schemas/payment.pricing.UsageTransformer.in", "customType": "payment.pricing.UsageTransformer.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for flat rate with overages pricing template processing.", "example": "", "default": "flat_rate_with_overages" }, { "name": "useAverageReducer", "kind": "optional", "type": "string", "description": "Usage granularity for calculating average values before applying flat rate with overages pricing.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.in", "customType": "payment.pricing.price.UsageGranularity.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", "description": "Discriminator field identifying this as a constant ratio fee type.", "example": "", "default": "constant_invoice_ratio_fee" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Product identifier this invoice-based fee applies to.", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this invoice-based fee configuration.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Human-readable name for this fee configuration.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed explanation of this fee's purpose and calculation method.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the fee is active or locked.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds of the last update to this fee.", "example": 0 }, { "name": "percentsOfInvoice", "kind": "optional", "type": "number", "description": "Percentage of invoice total to charge as fee in decimal format.", "example": "" }, { "name": "minimumFeePerFullCycle", "kind": "optional", "type": "number", "description": "Optional minimum fee amount charged per complete billing cycle.", "example": "" } ] } ] }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "description": "To indicate if the pricing plan should allow real-time workflows (e.g. top-ups)", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.plans.generators.CustomPlanGenerator.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Returns the newly created product plan with all configured pricing details and rules", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Pricing plan configuration for a product defining billing periods, pricing structures, fees, and subscription options for customers.", "customType": "payment.pricing.ProductPlan.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the product plan within the account.", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Identifier of the parent product that contains this pricing plan.", "example": "" }, { "name": "productItemPriceIdsMap", "kind": "optional", "type": "map", "description": "Map linking product item IDs to their corresponding price configuration IDs.", "example": "", "customType": "map", "schema": [] }, { "name": "billingPeriod", "kind": "optional", "type": "object", "description": "Billing cycle configuration defining frequency and interval for invoice generation.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "Time interval unit for billing cycle such as day, month, or year", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "description": "Number of intervals in billing cycle with minimum value of 1", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Free usage allowance before charges apply, applied across all product items in the plan.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "List of invoice-based fee identifiers that apply to this plan for recurring charges.", "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": "productPlanName", "kind": "optional", "type": "string", "description": "Human-readable name for the product plan displayed to customers and in billing.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed description explaining the plan features, pricing model, and target use cases.", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Timestamp in milliseconds when the product plan configuration was last modified.", "example": 0 }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Map of fixed fees associated with this plan, including setup, recurring, and one-time charges.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of feature entitlements and access permissions included in this plan.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the entitlement used in feature flag controls and access validation.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable display name for the entitlement shown in user interfaces and documentation.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API reference name for programmatic entitlement checks and feature gate logic.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification status controlling whether the plan can be edited or deprecated.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Flag indicating whether this is the default plan automatically assigned to new customers.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "description": "Identifier of the replacement plan when this plan is deprecated or discontinued.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Strategy for transitioning customers from this plan to its successor plan.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "type", "kind": "optional", "type": "string", "description": "Plan type categorization such as flat-rate, seat-based, or usage-based pricing model.", "example": "" }, { "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", "description": "List of fixed fee identifiers that must be prepaid for this plan.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid amount purchased every billing period at plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid amounts purchased every billing period per product item.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.in", "customType": "payment.pricing.prepaid.PrepaidProductItem.in[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item identifier that is associated with the prepaid credit amount.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid credit amount allocated to this specific product item for usage.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum prepaid balance threshold triggering automatic top-up purchases.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "description": "Product item ID to minimum prepaid balance map for automatic purchases.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planGenerator", "kind": "optional", "type": "object", "description": "The template of the plan generator", "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": "Discriminator field identifying this as a custom pricing plan generator.", "example": "", "default": "custom_pricing_plan" }, { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for this custom pricing plan template.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing frequency determining how often invoices are generated for this plan.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "Time interval unit for billing cycle such as day, month, or year", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "description": "Number of intervals in billing cycle with minimum value of 1", "example": 0 } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Free usage amount available at the plan level before charges apply.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "List of fee identifiers for custom invoice-based cost calculations.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planMinimumPayment", "kind": "optional", "type": "number", "description": "Minimum payment amount required for this pricing plan.", "example": "" }, { "name": "minimumPaymentGranularity", "kind": "optional", "type": "string", "description": "Granularity for minimum payment calculations, either hourly or entire invoice period.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.in", "customType": "payment.pricing.price.UsageGranularity.in", "schema": [] }, { "name": "planName", "kind": "required", "type": "string", "description": "Human-readable plan name for user interface display.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed description of the plan for user interface display.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Map of fee identifiers to their corresponding product plan fee configurations.", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of feature entitlements or API access rights included in this plan.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the entitlement used in feature flag controls and access validation.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable display name for the entitlement shown in user interfaces and documentation.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API reference name for programmatic entitlement checks and feature gate logic.", "example": "" } ] }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the plan can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if this is the default plan for new users.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "description": "Successor plan identifier for automatic migration when this plan is deprecated.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Strategy for transitioning to successor plan at deprecation time.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "prepaidBuyingRules", "kind": "optional", "type": "object", "description": "Rules governing prepaid card purchases for this pricing plan.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "description": "List of fixed fee identifiers that must be prepaid for this plan.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid amount purchased every billing period at plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid amounts purchased every billing period per product item.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidProductItem.in", "customType": "payment.pricing.prepaid.PrepaidProductItem.in[]", "schema": [ { "name": "productItemId", "kind": "optional", "type": "string", "description": "Product item identifier that is associated with the prepaid credit amount.", "example": "" }, { "name": "prepaidAmount", "kind": "optional", "type": "number", "description": "Prepaid credit amount allocated to this specific product item for usage.", "example": "" } ] }, { "name": "walletMinPrepaidAvailable", "kind": "optional", "type": "number", "description": "Minimum prepaid balance threshold triggering automatic top-up purchases.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "description": "Product item ID to minimum prepaid balance map for automatic purchases.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "planCurrency", "kind": "optional", "type": "string", "description": "Custom currency for this plan in ISO 4217 format.", "example": "USD" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of price generators defining the billing logic for this plan.", "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": "Dimension key names used to identify different dimensional variations for cost-plus pricing calculations.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this cost-plus dimensional pricing generator configuration and billing operations.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this cost-plus dimensional pricing generator applies to for billing.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this cost-plus pricing generator displayed in user interfaces and reports.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Lock status indicating whether this cost-plus pricing generator configuration can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Numerical multiplier applied to usage values before cost-plus pricing calculations and tier evaluations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Dimension-specific multipliers applied to usage values based on dimensional characteristics for cost-plus pricing.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Map of dimension name value pairs that must match for scalar to apply.", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Positive multiplier value applied to usage when dimension constraints are satisfied.", "example": "" } ] }, { "name": "priceTiers", "kind": "required", "type": "array", "description": "Tiered pricing structure defining cost-plus rates and thresholds for different usage volume ranges.", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredPriceGroupInfo.out", "customType": "payment.pricing.price.generators.TieredPriceGroupInfo.out[]", "schema": [ { "name": "dimensionValues", "kind": "optional", "type": "array", "description": "Dimension values that define the specific dimensional combination for this tiered pricing group configuration.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTiers", "kind": "optional", "type": "array", "description": "Tiered pricing structure defining rates and thresholds for different usage volume ranges or billing periods.", "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", "description": "Pricing leaf node type that determines how final price calculations are performed for this tier group.", "example": "" } ] }, { "name": "allowPartialBatch", "kind": "optional", "type": "boolean", "description": "Flag indicating whether partial batch processing is allowed for cost-plus pricing tier calculations.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for cost-plus dimensional pricing template processing and validation.", "example": "", "default": "cost_plus_dimension" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this cost-plus pricing generator configuration without dimensional variations.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this cost-plus pricing generator applies to for billing operations.", "example": "" }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this cost-plus pricing generator displayed in user interfaces and reports.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Numerical multiplier applied to usage values before cost-plus pricing calculations and tier evaluations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Dimension-specific multipliers applied to usage values despite this generator having no primary 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": "Tiered pricing structure defining cost-plus rates and thresholds for different usage volume ranges.", "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": "Flag indicating whether partial batch processing is allowed for cost-plus pricing tier calculations.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for cost-plus non-dimensional pricing template processing and validation.", "example": "", "default": "cost_plus_no_dimension" } ] }, { "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": "List of invoice-based service fees applied to this plan.", "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", "description": "Discriminator field identifying this as a constant ratio fee type.", "example": "", "default": "constant_invoice_ratio_fee" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Product identifier this invoice-based fee applies to.", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this invoice-based fee configuration.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Human-readable name for this fee configuration.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed explanation of this fee's purpose and calculation method.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the fee is active or locked.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds of the last update to this fee.", "example": 0 }, { "name": "percentsOfInvoice", "kind": "optional", "type": "number", "description": "Percentage of invoice total to charge as fee in decimal format.", "example": "" }, { "name": "minimumFeePerFullCycle", "kind": "optional", "type": "number", "description": "Optional minimum fee amount charged per complete billing cycle.", "example": "" } ] } ] }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "description": "Enables real-time pricing workflows such as automatic top-ups for this plan.", "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": "Unique identifier for this flat rate pricing plan template.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing frequency determining how often invoices are generated for this plan.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "Time interval unit for billing cycle such as day, month, or year", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "description": "Number of intervals in billing cycle with minimum value of 1", "example": 0 } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Human-readable name for this flat rate pricing plan.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "array", "description": "List of flat rate price generators defining the billing logic.", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "customType": "payment.pricing.price.generators.FlatRatePriceGenerator.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for this flat rate pricing generator configuration and billing operations.", "example": "" }, { "name": "flatRate", "kind": "required", "type": "number", "description": "Fixed monetary amount charged regardless of usage volume for flat rate pricing model.", "example": "" }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Product item identifier that this flat rate pricing generator applies to for billing operations.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Lock status indicating whether this flat rate pricing generator configuration can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "productItemInvoiceLabel", "kind": "optional", "type": "string", "description": "Optional custom label displayed on invoices to override default product item naming conventions.", "example": "" }, { "name": "productItemPriceName", "kind": "optional", "type": "string", "description": "Human-readable name for this flat rate pricing generator displayed in user interfaces.", "example": "" }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Optional numerical multiplier applied to usage values before flat rate pricing calculations.", "example": "" }, { "name": "dimensionalScalars", "kind": "optional", "type": "array", "description": "Optional dimension-specific multipliers applied to usage values for flat rate pricing variations.", "modelRef": "#/components/schemas/payment.pricing.price.DimensionalScalar.in", "customType": "payment.pricing.price.DimensionalScalar.in[]", "schema": [ { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Map of dimension name value pairs that must match for scalar to apply.", "example": "", "customType": "map", "schema": [] }, { "name": "scalar", "kind": "optional", "type": "number", "description": "Positive multiplier value applied to usage when dimension constraints are satisfied.", "example": "" } ] }, { "name": "usageTransformer", "kind": "optional", "type": "object", "description": "Optional usage data transformer configuration for modifying usage before flat rate pricing.", "modelRef": "#/components/schemas/payment.pricing.UsageTransformer.out", "customType": "payment.pricing.UsageTransformer.out", "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/common.dimensions_interpolation.DimensionsInterpolation.out", "customType": "common.dimensions_interpolation.DimensionsInterpolation.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "common.dimensions_interpolation.ListNumericInterpolation.in", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.ListNumericInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "common.dimensions_interpolation.TableInterpolation.out", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.TableInterpolation.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "common.dimensions_interpolation.TiersInterpolation.in", "description": "", "modelRef": "#/components/schemas/common.dimensions_interpolation.TiersInterpolation.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredDimensions", "kind": "optional", "type": "array", "description": "Required dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Indicates if the plan can be modified or not.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "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": "type", "kind": "optional", "type": "string", "description": "Fixed generator type identifier for flat rate pricing template processing and validation.", "example": "", "default": "flat_rate" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed description of the flat rate plan for user interface.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "List of fee identifiers for custom invoice-based cost calculations.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if this is the default flat rate plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the plan can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Free usage amount available at the plan level before charges apply.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "description": "Successor plan identifier for automatic migration when this plan is deprecated.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Strategy for transitioning to successor plan at deprecation time.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of feature entitlements or API access rights included in plan.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the entitlement used in feature flag controls and access validation.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable display name for the entitlement shown in user interfaces and documentation.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API reference name for programmatic entitlement checks and feature gate logic.", "example": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Discriminator field identifying this as a flat rate plan generator.", "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": "Unique identifier for this pay-and-go pricing plan template.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing frequency determining how often invoices are generated for this plan.", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "Time interval unit for billing cycle such as day, month, or year", "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", "description": "Number of intervals in billing cycle with minimum value of 1", "example": 0 } ] }, { "name": "planName", "kind": "required", "type": "string", "description": "Human-readable name for this pay-and-go pricing plan.", "example": "" }, { "name": "prepaidBuyingRules", "kind": "required", "type": "object", "description": "Rules governing prepaid credit purchases for this pay-and-go plan.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "customType": "payment.pricing.prepaid.PlanPrepaidBuyingRules.out", "schema": [ { "name": "planFixedFeeIdsToPrepay", "kind": "optional", "type": "array", "description": "List of fixed fee identifiers that must be prepaid for this plan.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "planRecurringPrepaidAmount", "kind": "optional", "type": "number", "description": "Recurring prepaid amount purchased every billing period at plan level.", "example": "" }, { "name": "productItemRecurringPrepaidAmount", "kind": "optional", "type": "array", "description": "Recurring prepaid amounts purchased every billing period per product item.", "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 prepaid balance threshold triggering automatic top-up purchases.", "example": "" }, { "name": "productItemMinPrepaidAvailable", "kind": "optional", "type": "map", "description": "Product item ID to minimum prepaid balance map for automatic purchases.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of usage-based price generators defining the billing logic.", "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": "Detailed description of the pay-and-go plan for user interface.", "example": "" }, { "name": "feeMap", "kind": "optional", "type": "map", "description": "Map of fixed fee identifiers to their product plan configurations.", "example": "", "customType": "map", "schema": [] }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "List of invoice-based fee identifiers added to invoices.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if this is the default pay-and-go plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the plan can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Free usage amount available at the plan level before charges apply.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "description": "Successor plan identifier for automatic migration when this plan is deprecated.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Strategy for transitioning to successor plan at deprecation time.", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.in", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.in", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of feature entitlements or API access rights included in plan.", "modelRef": "#/components/schemas/payment.pricing.Entitlements.Entitlement.in", "customType": "payment.pricing.Entitlements.Entitlement.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the entitlement used in feature flag controls and access validation.", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable display name for the entitlement shown in user interfaces and documentation.", "example": "" }, { "name": "apiName", "kind": "required", "type": "string", "description": "User-defined API reference name for programmatic entitlement checks and feature gate logic.", "example": "" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Discriminator field identifying this as a pay-and-go plan generator.", "example": "", "default": "pay_and_go" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for this usage-based pricing plan template.", "example": "" }, { "name": "billingPeriod", "kind": "required", "type": "object", "description": "Billing frequency determining how often invoices are generated for this plan.", "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": "Human-readable name for this usage-based pricing plan.", "example": "" }, { "name": "priceGenerators", "kind": "required", "type": "object", "description": "List of usage-based price generators defining the billing logic.", "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": "Detailed description of the usage-based plan for user interface.", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "description": "List of fee identifiers for custom invoice-based cost calculations.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "Indicates if this is the default usage-based plan for users.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status indicating if the plan can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "planLevelFreeTier", "kind": "optional", "type": "number", "description": "Free usage amount available at the plan level before charges apply.", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "description": "Successor plan identifier for automatic migration when this plan is deprecated.", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "Strategy for transitioning to successor plan at deprecation time.", "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": "List of feature entitlements or API access rights included in plan.", "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": "Discriminator field identifying this as a usage-based plan generator.", "example": "", "default": "pure_usage_based" } ] }, { "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": "planCurrency", "kind": "optional", "type": "string", "description": "The customized currency for the plan in ISO 4217 format.", "example": "USD" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "description": "Flag indicating whether pricing calculations occur in real-time during usage events.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.ProductPlan.out", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid plan generator configuration or unsupported pricing rules", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Authentication required or invalid API key provided", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Insufficient permissions to create pricing plans", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Referenced product items or templates not found", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal server error occurred while generating pricing plan", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "K_bOKTXAvPMUR24LdzPHv", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\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 }'" }, { "id": "6IqZKTZpDtgXEZocoqhvN", "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 \"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\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "vIxayrQPv6aHmKZJB8mR5", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan\")\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 \"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\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "PqxfyyGm4ia1dLMeCbGLh", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-plans/template/custom_pricing_plan\"\n\npayload = json.dumps({\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})\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": "K_bOKTXAvPMUR24LdzPHv" }, "results": { "languages": [ { "id": "VNzT1XjHhztDXV3uTj3Cg", "language": "200", "code": "// Returns the newly created product plan with all configured pricing details and rules\n{\n \"id\": \"\",\n \"productId\": \"\",\n \"productItemPriceIdsMap\": \"\",\n \"billingPeriod\": {\n \"interval\": \"\",\n \"intervalsCount\": \"\"\n },\n \"planLevelFreeTier\": 0,\n \"invoiceBasedFeeIds\": [\n \"\"\n ],\n \"planMinimumPayment\": 0,\n \"minimumPaymentGranularity\": \"\",\n \"productPlanName\": \"\",\n \"description\": \"\",\n \"lastUpdateTimeInMillis\": \"\",\n \"feeMap\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"apiName\": \"\"\n }\n ],\n \"lockingStatus\": \"\",\n \"isDefault\": false,\n \"successorPlanId\": \"\",\n \"transitionStrategy\": \"\",\n \"type\": \"\",\n \"prepaidBuyingRules\": {\n \"planFixedFeeIdsToPrepay\": [\n \"\"\n ],\n \"planRecurringPrepaidAmount\": 0,\n \"productItemRecurringPrepaidAmount\": [\n {\n \"productItemId\": \"\",\n \"prepaidAmount\": 0\n }\n ],\n \"walletMinPrepaidAvailable\": 0,\n \"productItemMinPrepaidAvailable\": \"\"\n },\n \"planGenerator\": {},\n \"planCurrency\": \"USD\",\n \"realTimePricing\": false\n}" }, { "id": "N5r8O3-zOU8UbqeWk7pUD", "language": "400", "code": "// Invalid plan generator configuration or unsupported pricing rules\n" }, { "id": "nxoZt6A4el1SffIXhhjWZ", "language": "401", "code": "// Authentication required or invalid API key provided\n" }, { "id": "BcV2cSqjtbL8pOJPZjfPC", "language": "403", "code": "// Insufficient permissions to create pricing plans\n" }, { "id": "xAkYsQil26rlIuhHMRqC6", "language": "404", "code": "// Referenced product items or templates not found\n" }, { "id": "30Z-i-_miqopBITSktRXI", "language": "500", "code": "// Internal server error occurred while generating pricing plan\n" } ], "selectedLanguageId": "VNzT1XjHhztDXV3uTj3Cg" } }, "children": [ { "text": "" } ] }