--- title: List all quotes slug: amberflo-api/list-all-quotes docTags: createdAt: 2024-11-07T15:10:16.973Z --- { "id": "nVI5uhh5jULhAmRy7kfmF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list" } ], "name": "List all quotes", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "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": "array", "description": "", "customType": "payment.pricing.customer.quote.DetailedCustomerQuote.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the quote.", "example": "" }, { "name": "owners", "kind": "required", "type": "array", "description": "Owners for the quote.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteOwner.out", "customType": "payment.pricing.customer.quote.CustomerQuoteOwner.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Owner id.", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Owner name.", "example": "" } ] }, { "name": "opportunityId", "kind": "required", "type": "string", "description": "Quote's opportunity id.", "example": "" }, { "name": "opportunityName", "kind": "required", "type": "string", "description": "Quote's opportunity name.", "example": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "Customer Id for the quote.", "example": "" }, { "name": "contractGenerator", "kind": "required", "type": "object", "description": "Commitment contract generator for the quote.", "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": "description", "kind": "optional", "type": "string", "description": "Quote description.", "example": "" }, { "name": "approverList", "kind": "optional", "type": "array", "description": "Quote approval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteReview.out", "customType": "payment.pricing.customer.quote.CustomerQuoteReview.out[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Reviewer id for the quote.", "example": "" }, { "name": "name", "kind": "required", "type": "string", "description": "Reviewer's display name for the quote.", "example": "" }, { "name": "approved", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "intervalUsages", "kind": "required", "type": "array", "description": "The list of intervals.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentIntervalUsageRequest.out[]", "schema": [ { "name": "timeRange", "kind": "required", "type": "object", "description": "The time range for the interval.", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "meterUsages", "kind": "required", "type": "array", "description": "The list of meter usages for product items.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentItemUsageRequest.out[]", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "name of the meter API.", "example": "" }, { "name": "dimensionKeys", "kind": "required", "type": "array", "description": "The keys for required dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "variantUsages", "kind": "required", "type": "array", "description": "The usages for item variants.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentVariantUsage.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentVariantUsage.out[]", "schema": [ { "name": "dimensionValues", "kind": "required", "type": "array", "description": "The item variant values for the dimensions.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "usageValue", "kind": "required", "type": "number", "description": "The usage for the", "example": "" }, { "name": "usageFrequency", "kind": "required", "type": "string", "description": "The frequency for each item variant usage.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentUsageFrequency.out", "schema": [] } ] } ] }, { "name": "promotions", "kind": "required", "type": "array", "description": "The promotions for the interval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPromotion.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPromotion.out[]", "schema": [ { "name": "existingPromotionId", "kind": "required", "type": "string", "description": "The unique ID for the customer.", "example": "" }, { "name": "inlinePromotion", "kind": "required", "type": "object", "description": "The unique ID for the product plan.", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "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": "", "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "intervalQuotes", "kind": "required", "type": "array", "description": "The usage interval quotes.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentIntervalUsageResponse.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentIntervalUsageResponse.out[]", "schema": [ { "name": "itemQuotes", "kind": "required", "type": "array", "description": "The time range for the interval.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentItemUsageResponse.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentItemUsageResponse.out[]", "schema": [ { "name": "itemQuote", "kind": "required", "type": "object", "description": "The quote cost for the item.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] } ] }, { "name": "intervalQuote", "kind": "required", "type": "object", "description": "The total quote cost details for the interval usage.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] } ] }, { "name": "totalQuote", "kind": "required", "type": "object", "description": "The total quote cost details.", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "customType": "payment.pricing.customer.quote.CustomerCommitmentPriceQuote.out", "schema": [ { "name": "quotedUsageCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost before applying discount.", "example": "" }, { "name": "quotedUsageCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ usage cost.", "example": "" }, { "name": "quotedUsageCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ usage cost after applying discount.", "example": "" }, { "name": "quotedFixedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost before applying discount.", "example": "" }, { "name": "quotedFixedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the CPQ fixed cost.", "example": "" }, { "name": "quotedFixedCostAfterDiscount", "kind": "required", "type": "number", "description": "The CPQ fixed cost after applying discount.", "example": "" }, { "name": "quotedCostBeforeDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost before applying discount.", "example": "" }, { "name": "quotedCostDiscount", "kind": "required", "type": "number", "description": "The discount for the total CPQ cost.", "example": "" }, { "name": "quotedCostAfterDiscount", "kind": "required", "type": "number", "description": "The total CPQ cost after applying discount.", "example": "" }, { "name": "totalMeterUnits", "kind": "required", "type": "number", "description": "The total units for the CPQ meter.", "example": "" } ] }, { "name": "term", "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": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteMetadata.out", "customType": "payment.pricing.customer.quote.CustomerQuoteMetadata.out", "schema": [ { "name": "lastUpdateEventTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "version", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "customerQuoteStatesMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "documentContractDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.DocumentContractDetails.out", "customType": "payment.pricing.customer.quote.DocumentContractDetails.out", "schema": [ { "name": "pdfFileBytes", "kind": "optional", "type": "string", "description": "The base 64 encoded PDF of CPQ contract", "example": "" }, { "name": "pdfContractSent", "kind": "optional", "type": "boolean", "description": "The sending status of the contract", "example": "" }, { "name": "docusignEnvelopeId", "kind": "optional", "type": "string", "description": "Envelope Id", "example": "" }, { "name": "customerEmail", "kind": "optional", "type": "string", "description": "The email of the customer", "example": "" }, { "name": "customerName", "kind": "optional", "type": "string", "description": "The name of the customer", "example": "" }, { "name": "senderEmail", "kind": "optional", "type": "string", "description": "The email of the sender", "example": "" }, { "name": "senderName", "kind": "optional", "type": "string", "description": "The name of the sender", "example": "" }, { "name": "customerStatus", "kind": "optional", "type": "array", "description": "The signing status of the customer", "modelRef": "#/components/schemas/payment.pricing.customer.quote.SigningStatus.out", "customType": "payment.pricing.customer.quote.SigningStatus.out[]", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of signature", "modelRef": "#/components/schemas/payment.pricing.customer.quote.Status.out", "customType": "payment.pricing.customer.quote.Status.out", "schema": [] }, { "name": "timeInSeconds", "kind": "optional", "type": "integer", "description": "The timestamp of current status is set", "example": 0 } ] }, { "name": "accountStatus", "kind": "optional", "type": "array", "description": "The signing status of the approver", "modelRef": "#/components/schemas/payment.pricing.customer.quote.SigningStatus.out", "customType": "payment.pricing.customer.quote.SigningStatus.out[]", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of signature", "modelRef": "#/components/schemas/payment.pricing.customer.quote.Status.out", "customType": "payment.pricing.customer.quote.Status.out", "schema": [] }, { "name": "timeInSeconds", "kind": "optional", "type": "integer", "description": "The timestamp of current status is set", "example": 0 } ] } ] }, { "name": "currentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.quote.CustomerQuoteState.out", "customType": "payment.pricing.customer.quote.CustomerQuoteState.out", "schema": [] }, { "name": "isLastVersion", "kind": "optional", "type": "boolean", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.customer.quote.DetailedCustomerQuote.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "sdT12OPSSQ83G75qr6K9D", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list \\\n --header 'accept: application/json'" }, { "id": "G33jaPOSrV3N3Pa34hTDi", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "H7-PtRNqFQVjNBvEI1tts", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "CXfSt91oG1EiQv35tm_WZ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-quote/list\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "sdT12OPSSQ83G75qr6K9D" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful request\n[\n {\n \"id\": \"\",\n \"owners\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"opportunityId\": \"\",\n \"opportunityName\": \"\",\n \"customerId\": \"\",\n \"contractGenerator\": {},\n \"description\": \"\",\n \"approverList\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"approved\": false\n }\n ],\n \"intervalUsages\": [\n {\n \"timeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"meterUsages\": [\n {\n \"meterApiName\": \"\",\n \"dimensionKeys\": [\n \"\"\n ],\n \"variantUsages\": [\n {\n \"dimensionValues\": [\n \"\"\n ],\n \"usageValue\": 0,\n \"usageFrequency\": \"\"\n }\n ]\n }\n ],\n \"promotions\": [\n {\n \"existingPromotionId\": \"\",\n \"inlinePromotion\": {}\n }\n ]\n }\n ],\n \"intervalQuotes\": [\n {\n \"itemQuotes\": [\n {\n \"itemQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n }\n }\n ],\n \"intervalQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n }\n }\n ],\n \"totalQuote\": {\n \"quotedUsageCostBeforeDiscount\": 0,\n \"quotedUsageCostDiscount\": 0,\n \"quotedUsageCostAfterDiscount\": 0,\n \"quotedFixedCostBeforeDiscount\": 0,\n \"quotedFixedCostDiscount\": 0,\n \"quotedFixedCostAfterDiscount\": 0,\n \"quotedCostBeforeDiscount\": 0,\n \"quotedCostDiscount\": 0,\n \"quotedCostAfterDiscount\": 0,\n \"totalMeterUnits\": 0\n },\n \"term\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"metadata\": {\n \"lastUpdateEventTimeSeconds\": \"\",\n \"version\": \"\"\n },\n \"customerQuoteStatesMap\": \"\",\n \"documentContractDetails\": {\n \"pdfFileBytes\": \"\",\n \"pdfContractSent\": false,\n \"docusignEnvelopeId\": \"\",\n \"customerEmail\": \"\",\n \"customerName\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"customerStatus\": [\n {\n \"status\": \"\",\n \"timeInSeconds\": \"\"\n }\n ],\n \"accountStatus\": [\n {\n \"status\": \"\",\n \"timeInSeconds\": \"\"\n }\n ]\n },\n \"currentStatus\": \"\",\n \"isLastVersion\": false\n }\n]" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }