--- title: Create a custom product plan slug: amberflo-api/create-a-custom-product-plan docTags: createdAt: 2024-11-07T15:10:16.978Z --- { "id": "_xaZuRqAdb4BwNppBJojw", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/price-override", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/price-override" } ], "name": "Create a custom product plan", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.CustomProductPlanRequest.in", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "planGenerator", "kind": "required", "type": "object", "description": "The PlanGenerator to create a custom product plan.", "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": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "The plan start time. Should be the start of the next billing period if the plan is part of a commitment", "example": 0 }, { "name": "endTimeInSeconds", "kind": "required", "type": "integer", "description": "The plan end time.", "example": 0 } ], "modelRef": "#/components/schemas/payment.pricing.CustomProductPlanRequest.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.ProductPlan.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productItemPriceIdsMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "billingPeriod", "kind": "optional", "type": "object", "description": "", "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", "example": "" }, { "name": "invoiceBasedFeeIds", "kind": "optional", "type": "array", "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": "productPlanName", "kind": "optional", "type": "string", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "example": 0 }, { "name": "feeMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "", "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": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "isDefault", "kind": "optional", "type": "boolean", "example": "" }, { "name": "successorPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "transitionStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.SuccessorPlanTransitionStrategy.out", "customType": "payment.pricing.SuccessorPlanTransitionStrategy.out", "schema": [] }, { "name": "type", "kind": "optional", "type": "string", "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", "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": "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": "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": "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": "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.out", "customType": "payment.pricing.price.generators.TieredPriceGroupInfo.out[]", "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.out", "customType": "payment.pricing.price.PriceTier.out[]", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "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.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.", "modelRef": "#/components/schemas/payment.pricing.price.PriceTier.out", "customType": "payment.pricing.price.PriceTier.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_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": "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": "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": "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": "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": "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.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/com.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.out", "customType": "com.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.out", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "com.amberflo.service.common.dimensions_interpolation.TableInterpolation.out", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.TableInterpolation.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.out", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.out", "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.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": "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": "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": "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": "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": "", "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.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": "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": "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": "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": "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": "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": "", "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": "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", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.ProductPlan.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "VYdsK2UAqgj8rH0FAMqVM", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/price-override \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"customerId\": \"\",\n \"planGenerator\": {\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 \"startTimeInSeconds\": 0,\n \"endTimeInSeconds\": 0\n }'" }, { "id": "96F8czfPMtbVefYaVCRMA", "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 \"planGenerator\": {\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 \"startTimeInSeconds\": 0,\n \"endTimeInSeconds\": 0\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-pricing/price-override\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "w-aQGmJCdcjK_K5-OhcpX", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/price-override\")\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 \"planGenerator\": {\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 \"startTimeInSeconds\": 0,\n \"endTimeInSeconds\": 0\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "nlIle89k6kM9YcwkM5rR1", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/price-override\"\n\npayload = json.dumps({\n \"customerId\": \"\",\n \"planGenerator\": {\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 \"startTimeInSeconds\": 0,\n \"endTimeInSeconds\": 0\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": "VYdsK2UAqgj8rH0FAMqVM" }, "results": { "languages": [ { "id": "dHsdw33AVrTmW7hSFlojG", "language": "200", "code": "// Successful request\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}" } ], "selectedLanguageId": "dHsdw33AVrTmW7hSFlojG" } }, "children": [ { "text": "" } ] }