--- title: Create or update a commitment slug: amberflo-api/qXUD-create-or-update-a-commitment docTags: createdAt: 2024-11-07T15:10:16.973Z --- { "id": "x1-JuExV4DGkbPk3y6PPx", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment" } ], "name": "Create or update a commitment", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.commitments.generators.PlanOverrideContractGenerator.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "plan_override_commitment" }, { "name": "customerId", "kind": "required", "type": "string", "description": "Customer id associated with this commitment.", "example": "" }, { "name": "cycles", "kind": "required", "type": "integer", "description": "The amount of billing cycles the commitment is going to last.", "example": 0 }, { "name": "planOverrideGenerator", "kind": "required", "type": "object", "description": "Plan override to be created with the commitment.", "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": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "Configuration for credit rollover.", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.in", "customType": "payment.pricing.commitments.CommitmentEndingConfig.in", "schema": [ { "name": "commitmentRestartConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentRestartConfig.in", "customType": "payment.pricing.commitments.CommitmentRestartConfig.in", "schema": [ { "name": "latestDecisionTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "optOut", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "extendPrepaidCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "Clauses that govern when this contract can be exited.", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.in", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_grace_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "gracePeriodInDays", "kind": "required", "type": "integer", "description": "The number of days before the contract begins serving as the deadline to cancel.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_notice_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "noticePeriodInDays", "kind": "required", "type": "integer", "description": "The length of the notice period.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_time_range" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "terminationRange", "kind": "required", "type": "object", "description": "Exit time range.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] } ] } ] }, { "name": "label", "kind": "optional", "type": "string", "description": "Label associated with this commitment.", "example": "" }, { "name": "notifyOnClientViolation", "kind": "optional", "type": "boolean", "description": "Whether to notify when a customer violation occurs.", "example": "" }, { "name": "promotions", "kind": "optional", "type": "array", "description": "List of promotions applied to this commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PromotionInfo.in", "customType": "payment.pricing.commitments.generators.PromotionInfo.in[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Existing promotion id.", "example": "" }, { "name": "startAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "customPromotion", "kind": "optional", "type": "object", "description": "Define a custom promotion.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.in", "customType": "payment.pricing.promotions.Promotion.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.in", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "The product item that we want to apply the promotion on", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "reward", "kind": "optional", "type": "object", "description": "Free credits given as part of this commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.in", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.in", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.in", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.in", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.in", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "used to calculate the time range for the commitment.", "example": 0 }, { "name": "upfrontPayment", "kind": "optional", "type": "object", "description": "Credit upfront payment to be purchased as part of the commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.in", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.in", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.in", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.in", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.in", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] } ], "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PlanOverrideContractGenerator.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.pricing.customer.CustomerCommitmentContract.out", "schema": [ { "name": "contractGenerator", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.ContractGenerator.out", "customType": "payment.pricing.commitments.generators.ContractGenerator.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.generators.CustomerArrearsContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CustomerArrearsContractGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "arrears_commitment_with_trueup" }, { "name": "customerId", "kind": "required", "type": "string", "example": "" }, { "name": "notifyOnClientViolation", "kind": "optional", "type": "boolean", "example": "" }, { "name": "planId", "kind": "required", "type": "string", "example": "" }, { "name": "planOverrideGenerator", "kind": "optional", "type": "object", "description": "", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "", "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.out", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "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": "", "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": "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": "", "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": "flat_rate" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "cycles", "kind": "required", "type": "integer", "description": "The amount of billing cycles the commitment is going to last.", "example": 0 }, { "name": "trueup", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.TrueUpInput.out", "customType": "payment.pricing.commitments.generators.TrueUpInput.out", "schema": [ { "name": "minimumPayment", "kind": "required", "type": "number", "example": "" }, { "name": "interval", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.TrueUpInterval.out", "customType": "payment.pricing.commitments.generators.TrueUpInterval.out", "schema": [] }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productItemIds", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "usePriceAfterDiscounts", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "promotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PromotionInfo.out", "customType": "payment.pricing.commitments.generators.PromotionInfo.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Existing promotion id.", "example": "" }, { "name": "startAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "customPromotion", "kind": "optional", "type": "object", "description": "Define a custom promotion.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "reward", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.out", "customType": "payment.pricing.commitments.CommitmentEndingConfig.out", "schema": [ { "name": "commitmentRestartConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentRestartConfig.out", "customType": "payment.pricing.commitments.CommitmentRestartConfig.out", "schema": [ { "name": "latestDecisionTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "optOut", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "extendPrepaidCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.out", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_grace_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "gracePeriodInDays", "kind": "required", "type": "integer", "description": "The number of days before the contract begins serving as the deadline to cancel.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_notice_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "noticePeriodInDays", "kind": "required", "type": "integer", "description": "The length of the notice period.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "isProductPlanModifiable", "kind": "optional", "type": "boolean", "description": "Can the ProductPlan be modified.", "example": "" } ] }, { "name": "payment.pricing.commitments.generators.CustomCommitmentContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CustomCommitmentContractGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "custom_commitment" }, { "name": "customerId", "kind": "required", "type": "string", "example": "" }, { "name": "notifyOnClientViolation", "kind": "optional", "type": "boolean", "example": "" }, { "name": "planId", "kind": "required", "type": "string", "example": "" }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "cycles", "kind": "required", "type": "integer", "description": "The amount of billing cycles the commitment is going to last.", "example": 0 }, { "name": "upfrontPayments", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out[]", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "installmentSchedule", "kind": "optional", "type": "array", "description": "A dictionary from cycle to the amount of money to pay.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "trueups", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.TrueUpInput.out", "customType": "payment.pricing.commitments.generators.TrueUpInput.out[]", "schema": [ { "name": "minimumPayment", "kind": "required", "type": "number", "example": "" }, { "name": "interval", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.TrueUpInterval.out", "customType": "payment.pricing.commitments.generators.TrueUpInterval.out", "schema": [] }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productItemIds", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "usePriceAfterDiscounts", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "credits", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out[]", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "rewards", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out[]", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "promotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PromotionInfo.out", "customType": "payment.pricing.commitments.generators.PromotionInfo.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Existing promotion id.", "example": "" }, { "name": "startAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endAtCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "customPromotion", "kind": "optional", "type": "object", "description": "Define a custom promotion.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "planOverrideGenerator", "kind": "optional", "type": "object", "description": "", "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": "", "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "", "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.CostPlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRatePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRatePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.FlatRateWithOveragesPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.InterchangePlusDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.TieredSeatBasedDimensionGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencyDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UltraFrequencySubscriptionWithOveragePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.MaxUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.SumUsageBasedNoDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumePriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.price.generators.UsageBasedVolumeDimensionPriceGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "invoiceBasedFees", "kind": "optional", "type": "object", "description": "The service fees for the invoice.", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.InvoiceBasedFee.out", "customType": "payment.pricing.invoice_based_fees.InvoiceBasedFee.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.invoice_based_fees.ConstantInvoiceRatioFee.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.plans.generators.FlatRatePlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.FlatRatePlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.PayAndGoPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.UsageBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SeatBasedPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.plans.generators.SubscriptionPlanGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.out", "customType": "payment.pricing.commitments.CommitmentEndingConfig.out", "schema": [ { "name": "commitmentRestartConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentRestartConfig.out", "customType": "payment.pricing.commitments.CommitmentRestartConfig.out", "schema": [ { "name": "latestDecisionTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "optOut", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "extendPrepaidCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.out", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_grace_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "gracePeriodInDays", "kind": "required", "type": "integer", "description": "The number of days before the contract begins serving as the deadline to cancel.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "isProductPlanModifiable", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "payment.pricing.commitments.generators.CustomerInstallmentContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CustomerInstallmentContractGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_installment" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "required", "type": "string", "example": "" }, { "name": "useTrueUp", "kind": "optional", "type": "boolean", "example": "" }, { "name": "notifyOnClientViolation", "kind": "optional", "type": "boolean", "example": "" }, { "name": "planId", "kind": "required", "type": "string", "example": "" }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.out", "customType": "payment.pricing.commitments.CommitmentEndingConfig.out", "schema": [ { "name": "commitmentRestartConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentRestartConfig.out", "customType": "payment.pricing.commitments.CommitmentRestartConfig.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "extendPrepaidCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "cycles", "kind": "required", "type": "integer", "description": "The amount of billing cycles the commitment is going to last.", "example": 0 }, { "name": "creditInstallmentInputs", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CreditInstallmentInput.out", "customType": "payment.pricing.commitments.generators.CreditInstallmentInput.out[]", "schema": [ { "name": "installmentPlan", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "billWhenTotalInstallmentPaymentExceeded", "kind": "optional", "type": "boolean", "example": "" }, { "name": "totalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "creditCardStartTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "creditCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "prepaidCardInputs", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out[]", "schema": [ { "name": "value", "kind": "required", "type": "number", "description": "Amount of prepaid.", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "label", "kind": "required", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "startCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endCycle", "kind": "optional", "type": "integer", "example": 0 }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "promotionsByCycle", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "committedPriceConfiguration", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CommittedPriceObligationConfiguration.out", "customType": "payment.pricing.commitments.generators.CommittedPriceObligationConfiguration.out", "schema": [ { "name": "totalPriceCommitted", "kind": "optional", "type": "integer", "example": 0 }, { "name": "usePriceAfterDiscounts", "kind": "optional", "type": "boolean", "example": "" }, { "name": "subtractCommitmentPrepaid", "kind": "optional", "type": "boolean", "example": "" }, { "name": "cycleObligation", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.out", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "isProductPlanModifiable", "kind": "optional", "type": "boolean", "description": "Can the ProductPlan be modified.", "example": "" } ] }, { "name": "payment.pricing.commitments.generators.InstallmentByUsageContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.InstallmentByUsageContractGenerator.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "installments_by_usage_commitment" }, { "name": "customerId", "kind": "required", "type": "string", "description": "Customer id associated with this commitment.", "example": "" }, { "name": "notifyOnClientViolation", "kind": "optional", "type": "boolean", "description": "Whether to notify when a customer violation occurs.", "example": "" }, { "name": "planId", "kind": "required", "type": "string", "description": "Product plan id associated with this commitment.", "example": "" }, { "name": "label", "kind": "required", "type": "string", "description": "Human readable label for the commitment entered by the user.", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "used to calculate the time range for the commitment.", "example": 0 }, { "name": "cycles", "kind": "required", "type": "integer", "description": "The amount of billing cycles the commitment is going to last.", "example": 0 }, { "name": "productItemIdToUsagePerInstallmentPeriod", "kind": "optional", "type": "map", "description": "Map of installment periods to map of product item id and usage commitment.", "example": "", "customType": "map", "schema": [] }, { "name": "trueup", "kind": "optional", "type": "object", "description": "Minimum payment commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.TrueUpInput.out", "customType": "payment.pricing.commitments.generators.TrueUpInput.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "billOnceCreditIsFinished", "kind": "optional", "type": "boolean", "description": "Whether to bill the customer in the current billing period once credits are exhausted.", "example": "" }, { "name": "promotions", "kind": "optional", "type": "array", "description": "List of promotions applied to this commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PromotionInfo.out", "customType": "payment.pricing.commitments.generators.PromotionInfo.out[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "reward", "kind": "optional", "type": "object", "description": "Free credits given as part of this commitment.", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PrepaidCardInput.out", "customType": "payment.pricing.commitments.generators.PrepaidCardInput.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "Configuration for credit rollover.", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.out", "customType": "payment.pricing.commitments.CommitmentEndingConfig.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "Clauses that govern when this contract can be exited.", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.out", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "isProductPlanModifiable", "kind": "optional", "type": "boolean", "description": "Can the ProductPlan be modified.", "example": "" } ] }, { "name": "payment.pricing.commitments.generators.InstallmentContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.InstallmentContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.MinCyclePriceToFixPlanAndDiscounts.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.MinCyclePriceToFixPlanAndDiscounts.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.PerCyclePrepaidContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PerCyclePrepaidContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.PlanOverrideContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.PlanOverrideContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.MinTotalPriceToFixPlanAndDiscounts.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.MinTotalPriceToFixPlanAndDiscounts.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.SubscriptionContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.SubscriptionContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.SubscriptionUsageCommitmentContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.SubscriptionUsageCommitmentContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.CustomerArrearsByUsageContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CustomerArrearsByUsageContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.UpfrontByUsageContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.UpfrontByUsageContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.generators.CustomerUpfrontContractGenerator.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.generators.CustomerUpfrontContractGenerator.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "contract", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentContract.out", "customType": "payment.pricing.commitments.CommitmentContract.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "" }, { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerObligations", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.CustomerObligation.out", "customType": "payment.pricing.commitments.customer.CustomerObligation.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.customer.PrepaidPaymentObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.PrepaidPaymentObligation.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "PrepaidPaymentObligation" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.commitments.customer.CustomerInstallmentObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.CustomerInstallmentObligation.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_installment_obligation" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "installmentSchedule", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "billWhenTotalInstallmentPaymentExceeded", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "payment.pricing.commitments.customer.CustomerSubscriptionObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.CustomerSubscriptionObligation.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_subscription_obligation" }, { "name": "contractId", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "cycleSubscriptionFee", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "payment.pricing.commitments.customer.MinItemInvoicedUsageFixedFine.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.MinItemInvoicedUsageFixedFine.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.customer.MinRunningAvgTotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.MinRunningAvgTotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.customer.MinTotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.customer.MinTotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "accountObligations", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.AccountObligation.out", "customType": "payment.pricing.commitments.account.AccountObligation.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.account.DiscountRampsObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.DiscountRampsObligation.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DiscountRampsObligation" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionRamps", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.pricing.commitments.account.PrepaidOrderingObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.PrepaidOrderingObligation.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "com.amberflo.metering.payment.model.pricing.commitments.account.PrepaidOrderingObligation" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "amountInBaseCurrency", "kind": "optional", "type": "number", "example": "" }, { "name": "isReward", "kind": "optional", "type": "boolean", "example": "" }, { "name": "currencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.out", "customType": "payment.pricing.prepaid.PrepaidPriority.out", "schema": [] }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.commitments.account.CreditObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.CreditObligation.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "credit_obligation" }, { "name": "accountId", "kind": "optional", "type": "string", "example": "" }, { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "amountCredited", "kind": "optional", "type": "number", "example": "" }, { "name": "cardId", "kind": "optional", "type": "string", "example": "" }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "obligationTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "payment.pricing.commitments.account.DiscountLock.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.DiscountLock.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.account.ItemPriceMachineLock.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.ItemPriceMachineLock.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.account.OrderObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.OrderObligation.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.account.PlanLock.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.PlanLock.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.commitments.account.PlanOverrideObligation.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.account.PlanOverrideObligation.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "commitmentViolationPolicy", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentViolationPolicy.out", "customType": "payment.pricing.commitments.CommitmentViolationPolicy.out", "schema": [ { "name": "notifyPerCustomerViolations", "kind": "optional", "type": "boolean", "example": "" }, { "name": "notifyPerAccountViolations", "kind": "optional", "type": "boolean", "example": "" }, { "name": "compensateOnCustomerViolation", "kind": "optional", "type": "boolean", "example": "" }, { "name": "compensateOnAccountViolation", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentEndingConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentEndingConfig.out", "customType": "payment.pricing.commitments.CommitmentEndingConfig.out", "schema": [ { "name": "commitmentRestartConfig", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.CommitmentRestartConfig.out", "customType": "payment.pricing.commitments.CommitmentRestartConfig.out", "schema": [ { "name": "latestDecisionTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "optOut", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "extendPrepaidCardEndTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "exitClauses", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitClause.out", "customType": "payment.pricing.commitments.exit_clauses.ExitClause.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.ExitBeforeCommitmentStartWithGracePeriod.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_grace_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "gracePeriodInDays", "kind": "required", "type": "integer", "description": "The number of days before the contract begins serving as the deadline to cancel.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationWithNoticePeriod.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_notice_period" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "noticePeriodInDays", "kind": "required", "type": "integer", "description": "The length of the notice period.", "example": 0 } ] }, { "name": "payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.commitments.exit_clauses.TerminationByTimeRange.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "termination_time_range" }, { "name": "id", "kind": "optional", "type": "string", "description": "Id of the exit clause.", "example": "" }, { "name": "terminationRange", "kind": "required", "type": "object", "description": "Exit time range.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "firstCustomerPlan", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerProductPlan.out", "customType": "payment.pricing.customer.CustomerProductPlan.out", "schema": [ { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "productPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "firstCustomerAppliedPromotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Unique product id.", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique promotion id to define an applied promotion.", "example": "" }, { "name": "appliedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Deprecated. When a promotion is in use in a customer pricing plan.", "example": 0 }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been added to a pricing plan.", "example": 0 }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been removed from a customer pricing plan.", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "description": "The unique ID of the relationship between the customer and promotion.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "When something is applied and removed with hourly granularity.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priority", "kind": "optional", "type": "number", "description": "How we rank promotions of the same type against each other.", "example": "" }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Identifying metadata around who and why a promotion was removed.", "example": "", "customType": "map", "schema": [] }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Optional field, populated by internal processes.", "example": "" }, { "name": "entityProductInvoices", "kind": "optional", "type": "array", "description": "List of invoices that this customer applied promotion was used on.", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "amountLeftInCycle", "kind": "optional", "type": "number", "description": "Amount of promotion left in cycle.", "example": "" }, { "name": "totalAmountLeft", "kind": "optional", "type": "number", "description": "Amount of promotion left in total.", "example": "" } ] }, { "name": "firstCustomerPrepaidCards", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCard.out", "customType": "payment.billing.prepaid_to_product.PrepaidCard.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.PrepaidCardByPrice.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByPrice.out", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "transferInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.PrepaidTransferInvoice.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "schema": [ { "name": "requestId", "kind": "optional", "type": "string", "example": "" }, { "name": "destinationPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_price" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "actualPrepaidChargePrice", "kind": "optional", "type": "number", "description": "The actual absolute charge amount for the prepaid card, in base currency.", "example": "" } ] }, { "name": "payment.billing.prepaid_to_product.PrepaidCardByUsage.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByUsage.out", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "transferInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.PrepaidTransferInvoice.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "schema": [ { "name": "requestId", "kind": "optional", "type": "string", "example": "" }, { "name": "destinationPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_usage" }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] } ] } ] }, { "name": "firstPrepaidCardsOrders", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerPrepaid.out", "customType": "payment.pricing.customer.CustomerPrepaid.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.customer.CustomerPrepaidByPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerPrepaidByPrice.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCardEndTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidOfferVersion", "kind": "optional", "type": "integer", "example": 0 }, { "name": "prepaidPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "originalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "originalCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "preferredPurchasingPrepaidCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "recurrenceFrequency", "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": "externalPayment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "senderPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.out", "customType": "payment.pricing.prepaid.PrepaidPriority.out", "schema": [] }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_prepaid_by_price" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "actualPrepaidChargePrice", "kind": "optional", "type": "number", "description": "The actual absolute charge amount for the prepaid card, in base currency.", "example": "" } ] }, { "name": "payment.pricing.customer.CustomerPrepaidByUsage.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerPrepaidByUsage.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCardEndTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidOfferVersion", "kind": "optional", "type": "integer", "example": 0 }, { "name": "prepaidPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "originalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "originalCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "preferredPurchasingPrepaidCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "recurrenceFrequency", "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": "externalPayment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "senderPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.out", "customType": "payment.pricing.prepaid.PrepaidPriority.out", "schema": [] }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_prepaid_by_usage" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "creationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCustomPromotions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.CustomerCustomPromotion.out", "customType": "payment.pricing.promotions.CustomerCustomPromotion.out[]", "schema": [ { "name": "promotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "The product item that we want to apply the promotion on", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "example": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "customerAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Unique product id.", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique promotion id to define an applied promotion.", "example": "" }, { "name": "appliedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Deprecated. When a promotion is in use in a customer pricing plan.", "example": 0 }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been added to a pricing plan.", "example": 0 }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been removed from a customer pricing plan.", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "description": "The unique ID of the relationship between the customer and promotion.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "When something is applied and removed with hourly granularity.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priority", "kind": "optional", "type": "number", "description": "How we rank promotions of the same type against each other.", "example": "" }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Identifying metadata around who and why a promotion was removed.", "example": "", "customType": "map", "schema": [] }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Optional field, populated by internal processes.", "example": "" }, { "name": "entityProductInvoices", "kind": "optional", "type": "array", "description": "List of invoices that this customer applied promotion was used on.", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "amountLeftInCycle", "kind": "optional", "type": "number", "description": "Amount of promotion left in cycle.", "example": "" }, { "name": "totalAmountLeft", "kind": "optional", "type": "number", "description": "Amount of promotion left in total.", "example": "" } ] } ] }, { "name": "firstOrders", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerSubscriptionOrder.out", "customType": "payment.pricing.customer.CustomerSubscriptionOrder.out[]", "schema": [ { "name": "customerId", "kind": "required", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "id", "kind": "required", "type": "string", "description": "The id of the specific instance in time where an order was applied to a customer, this id marks a unique customer order.", "example": "" }, { "name": "orderItems", "kind": "required", "type": "array", "description": "List of individual order items that make up this order.", "modelRef": "#/components/schemas/payment.pricing.customer.SubscriptionOrderItem.out", "customType": "payment.pricing.customer.SubscriptionOrderItem.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Instance id associated with the order item.", "example": "" }, { "name": "quantity", "kind": "required", "type": "number", "description": "Quantity of units the customer is subscribing to for this order.", "example": "" }, { "name": "resourceId", "kind": "optional", "type": "string", "description": "Resource id that this order item is applied to.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "Dimension key values that this order item is associated with.", "example": "", "customType": "map", "schema": [] }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Price for this order item. This is the total price for the full quantity over the order's duration, not the price per unit. If the order has a fixed duration this total price is for the entire duration. If the order has no fixed duration this total price is per billing period. If null, the price will be calculated based on the subscription plan's price per unit.", "example": "" } ] }, { "name": "productItemId", "kind": "required", "type": "string", "description": "Unique product item id.", "example": "" }, { "name": "productPlanId", "kind": "required", "type": "string", "description": "Unique product plan id.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "Applied time range for the order. This defines when an order starts and ends.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "billingPeriods", "kind": "optional", "type": "integer", "description": "Optional field to indicate the number of billing periods for the order. If this field is not null the order's end time will be calculated as this number of billing periods from the start time, inclusive of the billing period the start time falls within.", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "description": "Label for the order.", "example": "" }, { "name": "subscriptionSettings", "kind": "optional", "type": "object", "description": "Optional subscription settings to override the default subscription settings", "modelRef": "#/components/schemas/payment.pricing.subscription_orders.SubscriptionPriceSettings.out", "customType": "payment.pricing.subscription_orders.SubscriptionPriceSettings.out", "schema": [ { "name": "cancellationRule", "kind": "required", "type": "string", "description": "Whether early cancellation will prorate, charge in full, or result in no charge.", "modelRef": "#/components/schemas/payment.pricing.subscription_orders.CancellationRule.out", "customType": "payment.pricing.subscription_orders.CancellationRule.out", "schema": [] }, { "name": "chargeExecution", "kind": "required", "type": "string", "description": "When this order's charge will be executed.", "modelRef": "#/components/schemas/payment.pricing.subscription_orders.ChargeExecution.out", "customType": "payment.pricing.subscription_orders.ChargeExecution.out", "schema": [] }, { "name": "purchaseRule", "kind": "required", "type": "string", "description": "Whether the order will prorate or charge in full from the beginning of the billing period.", "modelRef": "#/components/schemas/payment.pricing.subscription_orders.PurchaseRule.out", "customType": "payment.pricing.subscription_orders.PurchaseRule.out", "schema": [] }, { "name": "subscriptionRate", "kind": "required", "type": "string", "description": "The rate of the subscription. This controls the granularity of subscription pricing within the billing period.", "modelRef": "#/components/schemas/payment.pricing.price.UsageGranularity.out", "customType": "payment.pricing.price.UsageGranularity.out", "schema": [] }, { "name": "isPricedPerRate", "kind": "optional", "type": "boolean", "description": "Whether subscription price is charged per rate or per billing period. Defaults to per billing period.", "example": "" }, { "name": "isCancellable", "kind": "optional", "type": "boolean", "description": "Whether order cancellation appears in the customer portal or not. Defaults to false.", "example": "" } ] }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Internally managed. When an order has been added to a pricing plan.", "example": 0 }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Internally managed. The id of an associated commitment.", "example": "" }, { "name": "prepaidUris", "kind": "optional", "type": "array", "description": "Internally managed. List of associated prepaid uris", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Internally managed. When an order has been removed from a customer pricing plan.", "example": 0 }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Internally managed. Identifying metadata around who and why an order was removed.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "firstPlanOverrideGenerators", "kind": "optional", "type": "object", "description": "", "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": "commitmentStateHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/payment.pricing.customer.CustomerCommitmentContract.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "zWKnPIgW6IozH6SpqK5nT", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": \"plan_override_commitment\",\n \"customerId\": \"\",\n \"cycles\": 0,\n \"planOverrideGenerator\": {\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 \"exitClauses\": {\n \"type\": \"termination_grace_period\",\n \"gracePeriodInDays\": 0\n },\n \"reward\": {\n \"value\": \"\",\n \"label\": \"\"\n },\n \"upfrontPayment\": {\n \"value\": \"\",\n \"label\": \"\"\n }\n }'" }, { "id": "R-4VuU_vkYAiSVphCL9ga", "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\": \"plan_override_commitment\",\n \"customerId\": \"\",\n \"cycles\": 0,\n \"planOverrideGenerator\": {\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 \"exitClauses\": {\n \"type\": \"termination_grace_period\",\n \"gracePeriodInDays\": 0\n },\n \"reward\": {\n \"value\": \"\",\n \"label\": \"\"\n },\n \"upfrontPayment\": {\n \"value\": \"\",\n \"label\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "UFGSlH0WYDRSL84sKkOVl", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment\")\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\": \"plan_override_commitment\",\n \"customerId\": \"\",\n \"cycles\": 0,\n \"planOverrideGenerator\": {\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 \"exitClauses\": {\n \"type\": \"termination_grace_period\",\n \"gracePeriodInDays\": 0\n },\n \"reward\": {\n \"value\": \"\",\n \"label\": \"\"\n },\n \"upfrontPayment\": {\n \"value\": \"\",\n \"label\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "G2V5PPEEU5FjfuJ_EFE9F", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-commitment/plan_override_commitment\"\n\npayload = json.dumps({\n \"type\": \"plan_override_commitment\",\n \"customerId\": \"\",\n \"cycles\": 0,\n \"planOverrideGenerator\": {\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 \"exitClauses\": {\n \"type\": \"termination_grace_period\",\n \"gracePeriodInDays\": 0\n },\n \"reward\": {\n \"value\": \"\",\n \"label\": \"\"\n },\n \"upfrontPayment\": {\n \"value\": \"\",\n \"label\": \"\"\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": "zWKnPIgW6IozH6SpqK5nT" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful request\n{\n \"contractGenerator\": {},\n \"contract\": {\n \"id\": \"\",\n \"type\": \"\",\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"customerObligations\": {},\n \"accountObligations\": {},\n \"commitmentViolationPolicy\": {\n \"notifyPerCustomerViolations\": false,\n \"notifyPerAccountViolations\": false,\n \"compensateOnCustomerViolation\": false,\n \"compensateOnAccountViolation\": false\n },\n \"timeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"productId\": \"\",\n \"commitmentEndingConfig\": {\n \"commitmentRestartConfig\": {\n \"latestDecisionTimeSeconds\": \"\",\n \"optOut\": false\n },\n \"extendPrepaidCardEndTimeInSeconds\": \"\"\n },\n \"exitClauses\": {}\n },\n \"firstCustomerPlan\": {\n \"productId\": \"\",\n \"productPlanId\": \"\",\n \"customerId\": \"\",\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"relationId\": \"\",\n \"createdTimeInSeconds\": \"\"\n },\n \"firstCustomerAppliedPromotions\": [\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"customerId\": \"\",\n \"promotionId\": \"\",\n \"appliedTimeInSeconds\": \"\",\n \"addedTimeInSeconds\": \"\",\n \"removedTimeInSeconds\": \"\",\n \"relationId\": \"\",\n \"appliedTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"priority\": 0,\n \"removalContext\": \"\",\n \"commitmentId\": \"\",\n \"entityProductInvoices\": [\n {\n \"invoiceUri\": \"\",\n \"createdTimeInSeconds\": \"\",\n \"amount\": 0,\n \"invoiceAmount\": 0\n }\n ],\n \"amountLeftInCycle\": 0,\n \"totalAmountLeft\": 0\n }\n ],\n \"firstCustomerPrepaidCards\": {},\n \"firstPrepaidCardsOrders\": {},\n \"creationTimeInSeconds\": \"\",\n \"firstCustomPromotions\": [\n {\n \"promotion\": {},\n \"customerAppliedPromotion\": {\n \"id\": \"\",\n \"productId\": \"\",\n \"customerId\": \"\",\n \"promotionId\": \"\",\n \"appliedTimeInSeconds\": \"\",\n \"addedTimeInSeconds\": \"\",\n \"removedTimeInSeconds\": \"\",\n \"relationId\": \"\",\n \"appliedTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"priority\": 0,\n \"removalContext\": \"\",\n \"commitmentId\": \"\",\n \"entityProductInvoices\": [\n {\n \"invoiceUri\": \"\",\n \"createdTimeInSeconds\": \"\",\n \"amount\": 0,\n \"invoiceAmount\": 0\n }\n ],\n \"amountLeftInCycle\": 0,\n \"totalAmountLeft\": 0\n }\n }\n ],\n \"firstOrders\": [\n {\n \"customerId\": \"\",\n \"id\": \"\",\n \"orderItems\": [\n {\n \"id\": \"\",\n \"quantity\": 0,\n \"resourceId\": \"\",\n \"dimensions\": \"\",\n \"totalPrice\": 0\n }\n ],\n \"productItemId\": \"\",\n \"productPlanId\": \"\",\n \"appliedTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"billingPeriods\": \"\",\n \"label\": \"\",\n \"subscriptionSettings\": {\n \"cancellationRule\": \"\",\n \"chargeExecution\": \"\",\n \"purchaseRule\": \"\",\n \"subscriptionRate\": \"\",\n \"isPricedPerRate\": false,\n \"isCancellable\": false\n },\n \"addedTimeInSeconds\": \"\",\n \"commitmentId\": \"\",\n \"prepaidUris\": [\n \"\"\n ],\n \"removedTimeInSeconds\": \"\",\n \"removalContext\": \"\"\n }\n ],\n \"firstPlanOverrideGenerators\": {},\n \"commitmentStateHistory\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }