{ "openapi":"3.0.1", "info":{ "title":"REST API Reference for Pricing Design Center", "version":"2025.04.24", "description":"The Pricing Design Center (PDC) REST API allows you to manage pricing objects, such as charge offers, discount offers, and packages, in PDC and BRM. It uses PDC server core APIs to manage PDC objects internally.", "x-summary":"The Pricing Design Center (PDC) REST API allows you to manage pricing objects, such as charge offers, discount offers, and packages, in PDC and BRM." }, "servers":[ { "url":"/pdc" } ], "tags":[ { "name":"PDC Pricing Management" } ], "paths":{ "/pricing":{ "post":{ "tags":[ "PDC Pricing Management" ], "summary":"Create Pricing Object", "description":"Creates a new pricing object using the criteria provided in the request body.", "operationId":"createPricing", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PricingObjectsJXB" }, "example":{ "chargeRatePlan":[ { "name":"sample_CRP_jan27", "pricingProfileName":"Subscription", "priceListName":"Default", "obsolete":false, "applicableRums":[ "Occurrence" ], "applicableQuantity":"ORIGINAL", "taxTime":"NONE", "todMode":"START_TIME", "applicableQtyTreatment":"CONTINUOUS", "permittedName":"TelcoGsmTelephony", "permittedType":"PRODUCT", "eventName":"EventBillingProductFeeCycleCycle_forward_monthly", "cycleFeeFlag":0, "billOffset":0, "subscriberCurrency":[ { "currencyCode":[ "USD" ], "crpRelDateRange":[ { "absoluteDateRange":{ "startDate":0, "endDate":"inf" }, "crpCompositePopModel":{ "name":"Pricing", "recurringPopModel":{ "priceTier":{ "lowerBound":"NO_MIN", "tierBasis":{ "rumTierExpression":{ } }, "rumName":"Occurrence", "enforceCreditLimit":"NORMAL", "tierRange":[ { "upperBound":"NO_MAX", "recurringCharge":[ { "price":10, "unitOfMeasure":"NONE", "balanceElementNumCode":840, "discountable":true, "priceType":"CONSUMPTION", "proratable":true, "impactType":"SCALED" } ] } ] } } } } ] } ] } ], "chargeOffering":[ { "name":"sample_CO_jan27", "pricingProfileName":"Product Offering", "priceListName":"Default", "obsolete":false, "timeRange":"0/inf", "productSpecName":"TelcoGsmTelephony", "offerType":"SUBSCRIPTION", "priority":0, "partial":false, "purchaseMin":-1, "purchaseMax":-1, "ownMin":-1, "ownMax":-1, "applicableQuantity":"REMAINING", "purchaseCycleDOM":0, "expiryNotification":true, "subscriptionDueNotification":true, "dateRangeImpactType":"EVENT_DATE", "groupSharingEnabled":false, "validityRounding":"off", "scaleRounding":"off", "chargeEventMap":[ { "eventName":"EventBillingProductFeeCycleCycle_forward_monthly", "validIfCancelled":true, "validIfInactive":true, "validIfSuspendedActive":true, "timezoneMode":"EVENT", "minQuantity":0, "minQuantityUnit":"NONE", "incrementQuantity":1, "incrementQuantityUnit":"NONE", "roundingMode":"NEAREST", "prorateFirst":"PRORATE_CHARGE", "prorateLast":"PRORATE_CHARGE", "prorateCycle":"PRORATE_CHARGE", "chargeRatePlanInfo":{ "targetEngine":[ "RRE" ] }, "chargeRatePlanName":"sample_CRP_jan27" } ] } ] } } } }, "responses":{ "201":{ "description":"The pricing object was created successfully." }, "400":{ "description":"The request isn't valid." }, "500":{ "description":"An internal service error occurred." } }, "x-internal-id":"pricing-post", "x-filename-id":"pricing-post" }, "get":{ "tags":[ "PDC Pricing Management" ], "summary":"Get Pricing Object", "description":"Gets one or more pricing objects. You can retrieve all pricing data in your system or add query parameters to retrieve a specific pricing object.", "operationId":"getPricing", "parameters":[ { "description":"The name of the pricing object.", "in":"query", "name":"name", "required":false, "schema":{ "type":"string" } }, { "description":"The type of pricing object: ALTERATION_RATE_PLAN, CHARGE_RATE_PLAN, DISTRIBUTION_RATE_PLAN, ROLLOVER_RATE_PLAN, ATTRIBUTE_ANALYZER_MODEL, ALTERATION_RATE_PLAN_SELECTOR, CHARGE_RATE_PLAN_SELECTOR, PRICE_MODEL_SELECTOR, TIME_MODEL, TRIGGER_SPEC, CHARGE_SELECTOR_SPEC, CHARGE_OFFERING, ALTERATION_OFFERING, DISTRIBUTION_OFFERING, PRICE_MODEL, PACKAGE_OBJ, PACKAGE_LIST, ALTERATION_EXCLUSION, PACKAGE_EXCLUSION, PACKAGE_TRANSITION, BUNDLE_TRANSITION, BEST_PRICING, BUNDLED_PRODUCT_OFFERING, BUNDLE_DEPENDENCY, GENERIC_SELECTOR, TAX_SELECTOR, TAX_EXEMPTION_SELECTOR, APN_MAP, USC_MAP, SUBSCRIPTION_TERMS, or SUBSCRIPTION_TERMS_AUTO_RENEW.", "in":"query", "name":"type", "required":false, "schema":{ "type":"string" } }, { "description":"Whether to include referenced objects in the response payload: true or false.", "in":"query", "required":false, "name":"includeReferences", "schema":{ "type":"string" } } ], "responses":{ "200":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PricingObjectsJXB" } } }, "description":"The pricing objects were returned successfully." }, "400":{ "description":"The query parameter isn't valid." }, "500":{ "description":"An internal server error occurred." } }, "x-internal-id":"pricing-get", "x-filename-id":"pricing-get" }, "put":{ "tags":[ "PDC Pricing Management" ], "summary":"Update Pricing Objects", "description":"Updates the specified pricing objects.", "operationId":"updatePricing", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PricingObjectsJXB" } } } }, "responses":{ "200":{ "description":"The pricing objects were updated successfully." }, "400":{ "description":"The JSON payload isn't valid." }, "500":{ "description":"An internal server error occurred." } }, "x-internal-id":"pricing-put", "x-filename-id":"pricing-put" } }, "/pricing/{id}":{ "delete":{ "tags":[ "PDC Pricing Management" ], "summary":"Delete Pricing Object by ID", "description":"Deletes the pricing object that matches the specified ID.", "operationId":"deletePricing", "parameters":[ { "description":"The ID of the pricing object.", "in":"path", "name":"id", "required":true, "schema":{ "type":"string" } }, { "description":"The type of pricing object: ALTERATION_RATE_PLAN, CHARGE_RATE_PLAN, DISTRIBUTION_RATE_PLAN, ROLLOVER_RATE_PLAN, ATTRIBUTE_ANALYZER_MODEL, ALTERATION_RATE_PLAN_SELECTOR, CHARGE_RATE_PLAN_SELECTOR, PRICE_MODEL_SELECTOR, TIME_MODEL, TRIGGER_SPEC, CHARGE_SELECTOR_SPEC, CHARGE_OFFERING, ALTERATION_OFFERING, DISTRIBUTION_OFFERING, PRICE_MODEL, PACKAGE_OBJ, PACKAGE_LIST, ALTERATION_EXCLUSION, PACKAGE_EXCLUSION, PACKAGE_TRANSITION, BUNDLE_TRANSITION, BEST_PRICING, BUNDLED_PRODUCT_OFFERING, BUNDLE_DEPENDENCY, GENERIC_SELECTOR, TAX_SELECTOR, TAX_EXEMPTION_SELECTOR, APN_MAP, USC_MAP, SUBSCRIPTION_TERMS, or SUBSCRIPTION_TERMS_AUTO_RENEW.", "in":"query", "name":"type", "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The pricing object was deleted successfully." }, "404":{ "description":"The pricing object couldn't be found." }, "500":{ "description":"An internal server error occurred." } }, "x-internal-id":"pricing-{id}-delete", "x-filename-id":"pricing-id-delete" } } }, "security":[ { "BasicAuthentication":[ ] } ], "components":{ "securitySchemes":{ "BasicAuthentication":{ "type":"http", "scheme":"basic" } }, "schemas":{ "PriceModelJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "alterationPopModel":{ "$ref":"#/components/schemas/AlterationPopModelJXB" }, "oneTimePopModel":{ "$ref":"#/components/schemas/OneTimePopModelJXB" }, "recurringPopModel":{ "$ref":"#/components/schemas/RecurringPopModelJXB" }, "replacementPopModel":{ "$ref":"#/components/schemas/ReplacementPopModelJXB" }, "rolloverPopModel":{ "$ref":"#/components/schemas/RolloverPopModelJXB" }, "usageChargePopModel":{ "$ref":"#/components/schemas/UsageChargePopModelJXB" }, "externalID":{ "type":"string" } }, "type":"object" }, "TimeModelJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "holidayCalendarName":{ "type":"string" }, "validityPeriod":{ "items":{ "$ref":"#/components/schemas/TimeModelValidityPeriodJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "AttributeAnalyzerModelJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "stereoType":{ "$ref":"#/components/schemas/AAStereoTypeJXB" }, "productSpecName":{ "type":"string" }, "eventSpecName":{ "type":"string" }, "customerSpecName":{ "type":"string" }, "validityPeriod":{ "items":{ "$ref":"#/components/schemas/AAValidityPeriodJXB" }, "type":"array" }, "modelData":{ "items":{ "$ref":"#/components/schemas/AAModelDataJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "TriggerSpecJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "chargeTriggerExpressionOrQuantityTriggerExpressionOrBalanceTriggerExpression":{ "items":{ "$ref":"#/components/schemas/ATriggerExpressionJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "ChargeSelectorSpecJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "validFrom":{ "type":"string" }, "validTo":{ "type":"string" }, "rumName":{ "items":{ "type":"string" }, "type":"array" }, "timeModelName":{ "items":{ "type":"string" }, "type":"array" }, "timeModelTagName":{ "type":"string" }, "zoneResult":{ "type":"string" }, "genericSelectorResult":{ "type":"string" }, "chargeRatePlanName":{ "items":{ "type":"string" }, "type":"array" }, "balanceElementNumCode":{ "items":{ "type":"string" }, "type":"array" }, "glid":{ "items":{ "type":"string" }, "type":"array" }, "zoneModelName":{ "items":{ "type":"string" }, "type":"array" }, "priceModelName":{ "items":{ "type":"string" }, "type":"array" }, "eventConditions":{ "items":{ "$ref":"#/components/schemas/ChargeSelectorEventConditionJXB" }, "type":"array" }, "pricingName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "ChargeRatePlanJXB":{ "description":"Refers to the charge rate plan pricing object.", "required":[ "name", "pricingProfileName", "applicableRums", "eventName", "subscriberCurrency" ], "properties":{ "name":{ "type":"string", "title":"name", "description":"The name of the charge rate plan." }, "newName":{ "type":"string", "title":"new name", "description":"The new name given to the already named charge rate plan." }, "description":{ "type":"string", "title":"description", "description":"Describes the charge rate plan." }, "createdDate":{ "type":"object", "title":"creation date", "description":"Refers to the date and time the object was created." }, "createdUser":{ "type":"string", "title":"creator", "description":"Refers to the user that created the object." }, "lastModifiedDate":{ "type":"object", "title":"modification date", "description":"Refers to the date and time the object was modified." }, "lastModifiedUser":{ "type":"string", "title":"modifier", "description":"Refers to the user that modified the object." }, "version":{ "format":"double", "type":"number", "title":"pdc version", "description":"Refers to the Pricing Design Center version of the object." }, "internalId":{ "type":"string", "title":"internal id", "description":"The unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration is commited." }, "currentStateName":{ "type":"string", "title":"current state name", "description":"The name of the current state of the charge rate plan." }, "changeSetName":{ "type":"string", "title":"change set name", "description":"The name of the change set of the charge rate plan." }, "pricingProfileName":{ "type":"string", "title":"pricing profile name", "description":"Name of the pricing profile. It determines the features supported for the charge based on the charge category and charge type." }, "priceListName":{ "type":"string", "title":"price list name", "description":"Name of the price list. By default, this is configured as Default. Keep the value as Default." }, "obsolete":{ "type":"boolean", "title":"obsolete", "description":"Obsoletes the promoted or active objects." }, "taxCode":{ "type":"string", "title":"tax code", "description":"The tax code used for the charge. You can use either this parameter or TaxSelectorGroup (name, id), however, you cannot use both at the same time." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"The name of the tax selector. The TaxSelectorGroup tag represents the tax selector information for the charge. You can use either TaxSelector or TaxCode, however, you cannot use both at the same time." }, "taxSelectorIID":{ "type":"string", "title":"tax selector id", "description":"Refers to the tax selector's ID. The TaxSelectorGroup tag represents the tax selector information for the charge. You can use either TaxSelector or TaxCode, however, you cannot use both at the same time." }, "applicableRums":{ "items":{ "type":"string" }, "type":"array", "title":"applicable rums", "description":"Displays the RUMs used in the charge. RUMs specify the units used to measure an event and how to calculate the measurement. For example, occurence, duration." }, "applicableQuantity":{ "$ref":"#/components/schemas/ApplicableQuantityJXB", "title":"applicable quantity", "description":"Specifies how charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"Refers to the time when the charge is taxed." }, "todMode":{ "$ref":"#/components/schemas/TODModeJXB", "title":"tod mode", "description":"Refers to the Time Of Day Mode. It indicates if events should be rated using startTime, endTime, or split to use both." }, "applicableQtyTreatment":{ "$ref":"#/components/schemas/ApplicableQuantityTreatmentJXB", "title":"applicable qty treatment", "description":"Indicates if the applicable quantity should be treated as continuous or isolated." }, "permittedName":{ "type":"string", "title":"permitted name", "description":"Refers to the service to which the charge applies." }, "permittedType":{ "$ref":"#/components/schemas/PermittedTypeJXB", "title":"permitted type", "description":"Specifies whether it is a product or a customer type." }, "eventName":{ "type":"string", "title":"event name", "description":"Refers to the name of the event. For example, EventDelayedSessionTelcoGsm (/event/delayed/session/telco/gsm in BRM) is used for usage events, while EventBillingProductFeeCycleCycle_forward_monthly (/event/billing/product/fee/cycle/cycle_forward_monthly) represents a monthly recurring fee (in-advance)." }, "cycleFeeFlag":{ "type":"integer", "title":"cycle fee flag", "description":"Specifies how to align recurring charges. '0' for billing date, '1' puchase date." }, "billOffset":{ "type":"integer", "title":"bill offset", "description":"Specifies the offset (number of days or months) to bill in advance." }, "offsetUnit":{ "$ref":"#/components/schemas/BillOffsetUnitJXB", "title":"offset unit", "description":"Specifies the offset unit (in days or months) to bill in advance." }, "ratePlanElement":{ "$ref":"#/components/schemas/ARatePlanElementJXB", "title":null, "description":null }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"Refers the currency details of the subscription. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"You use RUMs to measure events. The most common RUMs are Duration and Volume. Before you create product offerings, you must define the RUMs available for rating when you create the service-event map. For each event, you specify the RUMs that can be used for rating it. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"Refers to a set of rules that map service and event attributes and expressions to a result. It is used in a charge to apply prices based on the rule results. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp relative date range", "description":"Describes the relative date range validity of the charge rate plan. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"Refers to the container object used for modeling expressions based on event, product and customer attributes. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"Refers to the Zone model rate plan. Zone models are a set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables the user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"Refers to the generic product offering price model. It is a rateplan element that directly composes an alteration product offering price model. It can be one-time, recurring, or usage type. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. This is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object" }, "AlterationRatePlanJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "taxCode":{ "type":"string" }, "taxSelectorName":{ "type":"string" }, "taxSelectorIID":{ "type":"string" }, "resourcesConsumptionOrder":{ "$ref":"#/components/schemas/ResourcesConsumptionOrderJXB" }, "arpDateRange":{ "$ref":"#/components/schemas/AlterationDateRangeRPEBranchJXB" }, "alterationConfiguration":{ "items":{ "$ref":"#/components/schemas/AlterationRPEBranchJXB" }, "type":"array" }, "arpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" }, "alterationPopModelName":{ "type":"string" } }, "type":"object" }, "DistributionRatePlanJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "taxCode":{ "type":"string" }, "taxSelectorName":{ "type":"string" }, "taxSelectorIID":{ "type":"string" }, "drpDateRange":{ "items":{ "$ref":"#/components/schemas/DistributionDateRangeRPEBranchJXB" }, "type":"array" }, "distributionConfiguration":{ "items":{ "$ref":"#/components/schemas/DistributionRPEBranchJXB" }, "type":"array" }, "distributionPopModelName":{ "type":"string" }, "drpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" }, "externalID":{ "type":"string" } }, "type":"object" }, "RolloverRatePlanJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "taxCode":{ "type":"string" }, "taxSelectorName":{ "type":"string" }, "taxSelectorIID":{ "type":"string" }, "dateRange":{ "$ref":"#/components/schemas/RolloverRateDateRangeJXB" }, "externalID":{ "type":"string" } }, "type":"object" }, "ChargeOfferingJXB":{ "description":"Refers to the charge offer pricing object.", "required":[ "name", "pricingProfileName", "timeRange", "applicableQuantity", "chargeEventMap" ], "properties":{ "name":{ "type":"string", "title":"name", "description":"The charge offer's name." }, "newName":{ "type":"string", "title":"new name", "description":"Refers to the new name given to the already named charge offer." }, "description":{ "type":"string", "title":"description", "description":"Describes the charge offer." }, "createdDate":{ "type":"object", "title":"created date", "description":"Refers to the date and time the object was created." }, "createdUser":{ "type":"string", "title":"created user", "description":"Refers to the user that created the object." }, "lastModifiedDate":{ "type":"object", "title":"last modified date", "description":"Refers to the date and time the object was modified." }, "lastModifiedUser":{ "type":"string", "title":"last modified user", "description":"Refers to the user that modified the object." }, "version":{ "format":"double", "type":"number", "title":"charge offer version", "description":"Refers to the Pricing Design Center version of the object." }, "internalId":{ "type":"string", "title":"internal id", "description":"Refers to the Unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration was committed." }, "currentStateName":{ "type":"string", "title":"current state name", "description":"Refers to the name of current state of the charge offer." }, "changeSetName":{ "type":"string", "title":"change set name", "description":"Refers to the name of the change set of the charge offer." }, "pricingProfileName":{ "type":"string", "title":"pricing profile name", "description":"Determines which features are supported for the charge based on the charge category and charge type." }, "priceListName":{ "type":"string", "title":"price list name", "description":"The name of the price list. By default, this is configured as Default. Keep the value as Default." }, "obsolete":{ "type":"boolean", "title":"obsolete", "description":"Obsoletes the promoted or active objects." }, "timeRange":{ "type":"string", "title":"time range", "description":"Refers to the time range during which the offer is available for purchase. The format is startingTime/endingTime where TimeFormat is yyyymmddThhmmss and default value is 0/inf." }, "productSpecName":{ "type":"string", "title":"(required*) product specification name", "description":"Refers to the name of the service to which the charge offer applies. One of the fields customerSpecName and productSpecName are required and they are mutually exclusive." }, "customerSpecName":{ "type":"string", "title":"(required*) customer specification name", "description":"Refers to the tag used for Account as a service. One of the fields customerSpecName and productSpecName are required and they are mutually exclusive." }, "productSpecCharacteristic":{ "items":{ "$ref":"#/components/schemas/ProductSpecCharacteristicJXB" }, "type":"array", "description":"Defines custom attributes and their valid values for a charge offer." }, "offerType":{ "$ref":"#/components/schemas/OfferTypeJXB", "description":"Refers to the type of charge offer allowed. By default, the offer type is SUBSCRIPTION. Note thatAGGREGATION is not a valid offerType for a charge offering." }, "priority":{ "type":"integer", "title":"priority", "description":"Refers to the priority for the charge offer. A higher number is given to a higher priority. For example, if priority values are 1 and 2, then 2 would be given high priority." }, "provisioningTag":{ "type":"string", "title":"provisioning tag", "description":"Refers to the provisioning tag for the charge offer. This is used to implement extended rating attributes (ERAs) such as call forwarding, blocking, and discount for select calls." }, "policySpecification":{ "type":"string", "title":"policy specification", "description":"Refers to policy specification for the charge offer. This is made up of one or more counter policies, each of which defines a gradation in the quality of service (QoS) based on the subscriber's service usage." }, "partial":{ "type":"boolean", "title":"partial", "description":"Enables partial purchases." }, "purchaseMin":{ "format":"double", "type":"number", "title":"purchase minimum", "description":"Specifies the minimum number of charge offers that a customer can buy at one time. The default value for this -1, which means that by default, it is unlimited." }, "purchaseMax":{ "format":"double", "type":"number", "title":"purchase maximum", "description":"Specifies the maximum number of charge offers that a customer can buy at one time. The default value for this -1, which means that by default, it is unlimited." }, "ownMin":{ "format":"double", "type":"number", "title":"minimum no of charge offer can be owned", "description":"Specifies the minimum number of charge offers that a customer can own at one time. The default value for this -1, which means that by default, it is unlimited." }, "ownMax":{ "format":"double", "type":"number", "title":"maximum no of charge offer can be owned", "description":"Specifies the maximum number of charge offers that a customer can own at one time. The default value for this -1, which means that by default, it is unlimited." }, "taxSupplier":{ "type":"string", "title":"tax supplier", "description":"Refers to the tax supplier's name for the charge offer." }, "taxExemptionSelectorName":{ "type":"string", "title":"tax exemption selector name", "description":"The name of the tax exemption selector." }, "taxExemptionSelectorIID":{ "type":"string", "title":"tax exemption selector id", "description":"Refers to the tax exemption selector's ID." }, "applicableQuantity":{ "$ref":"#/components/schemas/ApplicableQuantityJXB", "description":"Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer." }, "purchaseCycleDOM":{ "format":"int32", "type":"integer", "title":"purchase cycle day of month", "description":"Refers to the day of the month for the purchase cycle. The product validity is aligned to the specific date or the billing date. The range is between 0 to 31 and the default is 0." }, "expiryNotification":{ "type":"boolean", "title":"expiry notification", "description":"Triggers notifications to be sent to the customer when the charge offer is about to expire. The default value is true>/b>." }, "subscriptionDueNotification":{ "type":"boolean", "title":"subscription due notification", "description":"Triggers notifications to be sent to the customer before the subscription is due for renewal. The default value is true." }, "dateRangeImpactType":{ "$ref":"#/components/schemas/DateRangeImpactTypeJXB", "description":"Sets the impact type when balance impacts are added with new date ranges to an existing charge offer. It specifies if the existing subscriptions move to the new balance impact or continue with the old balance impact." }, "deliverable":{ "items":{ "$ref":"#/components/schemas/ChargeOfferDeliverableJXB", "description":"Refers to a deliverable used by a charge offering. Deliverables specify when and how much revenue can be recognized from a customer's purchase of products and services." }, "type":"array" }, "retryMaxCount":{ "format":"int32", "type":"integer", "title":"maximum number of retry in total", "description":"Refers to the maximum number of times the customer can retry the subscription before it fails. The default value is 0 implying no retries allowed. This is applicable when the credit limit is set as AUTO_RENEW_CANCEL, RENTAL_FAILURE, or INSUFFICIENT_BALANCE." }, "retryUnit":{ "$ref":"#/components/schemas/RetryUnitJXB", "description":"Refers to the measurement unit for retrial frequency. The default value is Day. This is applicable when the credit limit is set as AUTO_RENEW_CANCEL, RENTAL_FAILURE, or INSUFFICIENT_BALANCE." }, "retryOffset":{ "format":"int32", "type":"integer", "title":"subsequent retry frequency", "description":"Refers to the frequency of subsequent retries. The default value is 1. This is applicable when the credit limit is set as AUTO_RENEW_CANCEL, RENTAL_FAILURE, or INSUFFICIENT_BALANCE." }, "groupSharingEnabled":{ "type":"boolean", "title":"group sharing enable/disable", "description":"Enables the charge offer to be shared with all members of a product sharing group when purchased by the group's owner. The default value is false." }, "validityRounding":{ "$ref":"#/components/schemas/ValidityRoundingModeJXB", "description":"Specifies whether to start the charge offer's validity period at the purchase time or at midnight of the purchase day. The default value is NOT_SET." }, "scaleRounding":{ "$ref":"#/components/schemas/ScaleRoundingModeJXB", "description":"Specifies whether to calculate the scale based on validityRounding." }, "chargeEventMap":{ "items":{ "$ref":"#/components/schemas/ChargeEventMapJXB" }, "type":"array" }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagWithDefaultJXB", "description":"Tags any pricing attribute at design time, which can then be used at the rating time to impact different prices. This field is applicable for GET method." }, "type":"array" }, "externalID":{ "type":"string", "title":"External id of charge offer.", "description":"Refers to the object's external ID. It is used to create cross references, in case of migration." } }, "type":"object" }, "AlterationOfferingJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "timeRange":{ "type":"string" }, "productSpecName":{ "type":"string" }, "customerSpecName":{ "type":"string" }, "productSpecCharacteristic":{ "items":{ "$ref":"#/components/schemas/ProductSpecCharacteristicJXB" }, "type":"array" }, "offerType":{ "$ref":"#/components/schemas/OfferTypeJXB" }, "priority":{ "type":"integer" }, "provisioningTag":{ "type":"string" }, "policySpecification":{ "type":"string" }, "purchaseMin":{ "format":"double", "type":"number" }, "purchaseMax":{ "format":"double", "type":"number" }, "ownMin":{ "format":"double", "type":"number" }, "ownMax":{ "format":"double", "type":"number" }, "applicableChargeAndQuantity":{ "$ref":"#/components/schemas/ApplicableChargeAndQuantityJXB" }, "groupSharingEnabled":{ "type":"boolean" }, "alterationEventMap":{ "items":{ "$ref":"#/components/schemas/AlterationEventMapJXB" }, "type":"array" }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagWithDefaultJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "DistributionOfferingJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "timeRange":{ "type":"string" }, "productSpecName":{ "type":"string" }, "customerSpecName":{ "type":"string" }, "productSpecCharacteristic":{ "items":{ "$ref":"#/components/schemas/ProductSpecCharacteristicJXB" }, "type":"array" }, "offerType":{ "$ref":"#/components/schemas/OfferTypeJXB" }, "distributionEventMap":{ "items":{ "$ref":"#/components/schemas/DistributionEventMapJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "SubscriptionTermsJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "termLength":{ "type":"integer" }, "termUnit":{ "$ref":"#/components/schemas/TermTimeUnitJXB" }, "earlyTerminationOption":{ "$ref":"#/components/schemas/EarlyTerminationOptionJXB" }, "terminationGraceLength":{ "type":"integer" }, "terminationGraceUnit":{ "$ref":"#/components/schemas/TermTimeUnitJXB" }, "penaltyAmount":{ "format":"double", "type":"number" }, "penaltyBalanceElementNumCode":{ "format":"int64", "type":"integer" }, "penaltyRevenueGlid":{ "format":"int32", "type":"integer" }, "penaltyOptions":{ "$ref":"#/components/schemas/ApplyPenaltyRuleJXB" }, "autoRenew":{ "type":"boolean" }, "externalID":{ "type":"string" } }, "type":"object" }, "BundledProductOfferingJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "timeRange":{ "type":"string" }, "productSpecName":{ "type":"string" }, "customerSpecName":{ "type":"string" }, "billOnPurchase":{ "type":"boolean" }, "firstUsageActivation":{ "type":"boolean" }, "subscriptionTermsIID":{ "type":"string" }, "subscriptionTermsName":{ "type":"string" }, "customize":{ "$ref":"#/components/schemas/CustomizeTypeJXB" }, "groupBalanceElements":{ "type":"boolean" }, "bundledProductOfferingItem":{ "items":{ "$ref":"#/components/schemas/BundledProductOfferingItemJXB" }, "type":"array" }, "productSpecCharacteristic":{ "items":{ "$ref":"#/components/schemas/ProductSpecCharacteristicJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "PackageJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "billOnPurchase":{ "type":"boolean" }, "firstUsageActivation":{ "type":"boolean" }, "customerSpecPackageItem":{ "$ref":"#/components/schemas/CustomerSpecPackageItemJXB" }, "productSpecPackageItem":{ "items":{ "$ref":"#/components/schemas/ProductSpecPackageItemJXB" }, "type":"array" }, "balanceSpecification":{ "items":{ "$ref":"#/components/schemas/BalanceSpecificationJXB" }, "type":"array" }, "subscriptionTermsIID":{ "type":"string" }, "subscriptionTermsName":{ "type":"string" }, "productSpecCharacteristic":{ "items":{ "$ref":"#/components/schemas/ProductSpecCharacteristicJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "AlterationOfferingExclusionJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "active":{ "type":"boolean" }, "prohibitedAlterationOfferingName":{ "type":"string" }, "alterationOfferingName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "PackageExclusionJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "active":{ "type":"boolean" }, "prohibitedAlterationOfferingName":{ "type":"string" }, "packageName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "PackageTransitionJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "active":{ "type":"boolean" }, "timeRange":{ "type":"string" }, "waivePurchaseFee":{ "type":"boolean" }, "waiveCancelFee":{ "type":"boolean" }, "customerSpecName":{ "type":"string" }, "productSpecName":{ "type":"string" }, "prorationType":{ "$ref":"#/components/schemas/ProrationTypeJXB" }, "type":{ "$ref":"#/components/schemas/PackageTransitionTypeJXB" }, "fromPackageName":{ "type":"string" }, "toPackageName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "BundledProductOfferingTransitionJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "active":{ "type":"boolean" }, "timeRange":{ "type":"string" }, "waivePurchaseFee":{ "type":"boolean" }, "waiveCancelFee":{ "type":"boolean" }, "customerSpecName":{ "type":"string" }, "productSpecName":{ "type":"string" }, "prorationType":{ "$ref":"#/components/schemas/ProrationTypeJXB" }, "type":{ "$ref":"#/components/schemas/BundledPOTransitionTypeJXB" }, "fromBundledProductOfferingName":{ "type":"string" }, "toBundledProductOfferingName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "BundledProductOfferingDependencyJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "active":{ "type":"boolean" }, "bundledProductOfferingName":{ "type":"string" }, "prohibitedBundledProductOfferingName":{ "type":"string" }, "prerequisiteBundledProductOfferingName":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "BestPricingJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "mode":{ "$ref":"#/components/schemas/BestPricingModeJXB" }, "bundledProductOfferingName":{ "type":"string" }, "alternateBundledProductOffering":{ "items":{ "$ref":"#/components/schemas/AlternateOfferingJXB" }, "type":"array" }, "externalID":{ "type":"string" } }, "type":"object" }, "PackageListJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "type":{ "type":"string" }, "segment":{ "type":"string" }, "packageName":{ "items":{ "type":"string" }, "type":"array" }, "packageListStatus":{ "$ref":"#/components/schemas/PackageListStatusJXB" }, "externalID":{ "type":"string" } }, "type":"object" }, "SubscriptionTermsAutoRenewJXB":{ "properties":{ "name":{ "type":"string" }, "newName":{ "type":"string" }, "description":{ "type":"string" }, "createdDate":{ "type":"object" }, "createdUser":{ "type":"string" }, "lastModifiedDate":{ "type":"object" }, "lastModifiedUser":{ "type":"string" }, "version":{ "format":"double", "type":"number" }, "internalId":{ "type":"string" }, "currentStateName":{ "type":"string" }, "changeSetName":{ "type":"string" }, "publishSchemas":{ "items":{ "type":"string" }, "type":"array" }, "pricingProfileName":{ "type":"string" }, "priceListName":{ "type":"string" }, "obsolete":{ "type":"boolean" }, "fromSubscriptionTermsName":{ "type":"string" }, "fromSubscriptionTermsIID":{ "type":"string" }, "toSubscriptionTermsName":{ "type":"string" }, "toSubscriptionTermsIID":{ "type":"string" }, "externalID":{ "type":"string" } }, "type":"object" }, "CustomerSpecPackageItemJXB":{ "properties":{ "balanceSpecificationName":{ "type":"string" }, "bundledProductOfferingAssociation":{ "$ref":"#/components/schemas/BundledProductOfferingAssociationJXB" } }, "type":"object" }, "ProductSpecPackageItemJXB":{ "properties":{ "name":{ "type":"string" }, "balanceSpecificationName":{ "type":"string" }, "productSpecName":{ "type":"string" }, "bundledProductOfferingAssociation":{ "items":{ "$ref":"#/components/schemas/BundledProductOfferingAssociationJXB" }, "type":"array" }, "subPackageItem":{ "items":{ "$ref":"#/components/schemas/ProductSpecPackageItemJXB" }, "type":"array" } }, "type":"object" }, "BalanceSpecificationJXB":{ "properties":{ "name":{ "type":"string" }, "balanceElementSpecification":{ "items":{ "$ref":"#/components/schemas/BalanceElementSpecificationJXB" }, "type":"array" } }, "type":"object" }, "ProductSpecCharacteristicJXB":{ "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "title":"product spec char name", "description":"The special characteristic's name." }, "value":{ "items":{ "type":"string" }, "type":"array", "title":"product spec char values", "description":"The list of special characteristics added for a given name." } }, "type":"object", "description":"Defines the custom attributes and their valid values for a charge offer." }, "BalanceElementSpecificationJXB":{ "properties":{ "balanceElementNumCode":{ "format":"int64", "type":"integer" }, "consumptionRule":{ "$ref":"#/components/schemas/ConsumptionRuleTypeJXB" }, "balanceCreditProfile":{ "$ref":"#/components/schemas/BalanceCreditProfileJXB" } }, "type":"object" }, "ConsumptionRuleTypeJXB":{ "enum":[ "EARLIEST_EXPIRATION", "EARLIEST_EXPIRATION_EARLIEST_START", "EARLIEST_EXPIRATION_LATEST_START", "EARLIEST_START", "EARLIEST_START_EARLIEST_EXPIRATION", "EARLIEST_START_LATEST_EXPIRATION", "LATEST_EXPIRATION", "LATEST_EXPIRATION_EARLIEST_START", "LATEST_EXPIRATION_LATEST_START", "LATEST_START", "LATEST_START_EARLIEST_EXPIRATION", "LATEST_START_LATEST_EXPIRATION", "NONE" ], "type":"string" }, "BalanceCreditProfileJXB":{ "properties":{ "floor":{ "format":"double", "type":"number" }, "ceiling":{ "format":"double", "type":"number" }, "thresholdLevel":{ "items":{ "$ref":"#/components/schemas/ThresholdLevelJXB" }, "type":"array" } }, "type":"object" }, "ThresholdLevelJXB":{ "properties":{ "threshold":{ "format":"double", "type":"number" }, "type":{ "$ref":"#/components/schemas/ThresholdTypeJXB" } }, "type":"object" }, "ThresholdTypeJXB":{ "enum":[ "ABSOLUTE", "ABSOLUTE_LOAN", "PERCENTAGE", "PERCENTAGE_LOAN" ], "type":"string" }, "BundledProductOfferingAssociationJXB":{ "properties":{ "optional":{ "type":"boolean" }, "cancelWithService":{ "type":"boolean" }, "bundledProductOfferingName":{ "type":"string" } }, "type":"object" }, "PackageListStatusJXB":{ "enum":[ "ACTIVE", "INACTIVE" ], "type":"string" }, "BestPricingModeJXB":{ "enum":[ "FULL_RERATE", "ONE_TIME_ADJUST" ], "type":"string" }, "AlternateOfferingJXB":{ "properties":{ "minimumAmount":{ "format":"double", "type":"number" }, "condition":{ "items":{ "$ref":"#/components/schemas/AlternateConditionJXB" }, "type":"array" }, "bundledProductOfferingName":{ "type":"string" } }, "type":"object" }, "AlternateConditionJXB":{ "properties":{ "amount":{ "format":"double", "type":"number" }, "operator":{ "$ref":"#/components/schemas/ConditionOperatorJXB" }, "balanceElementNumCode":{ "format":"int64", "type":"integer" } }, "type":"object" }, "ConditionOperatorJXB":{ "enum":[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "LESS_THAN", "LESS_THAN_EQUAL", "NOT_EQUAL_TO" ], "type":"string" }, "ProrationTypeJXB":{ "enum":[ "ORIGINAL_CHARGE", "PRORATE_CHARGE", "TRANSFER_CHARGE" ], "type":"string" }, "BundledPOTransitionTypeJXB":{ "enum":[ "DOWNGRADE", "UPGRADE" ], "type":"string" }, "PackageTransitionTypeJXB":{ "enum":[ "DOWNGRADE", "GENERATION_CHANGE", "UPGRADE" ], "type":"string" }, "CustomizeTypeJXB":{ "enum":[ "OPTIONAL", "PROHIBITED", "REQUIRED" ], "type":"string" }, "BundledProductOfferingItemJXB":{ "properties":{ "purchaseStart":{ "$ref":"#/components/schemas/ValidityJXB" }, "purchaseEnd":{ "$ref":"#/components/schemas/ValidityJXB" }, "usageStart":{ "$ref":"#/components/schemas/ValidityJXB" }, "usageEnd":{ "$ref":"#/components/schemas/ValidityJXB" }, "cycleStart":{ "$ref":"#/components/schemas/ValidityJXB" }, "cycleEnd":{ "$ref":"#/components/schemas/ValidityJXB" }, "status":{ "type":"integer" }, "statusCode":{ "type":"integer" }, "renewalMode":{ "type":"boolean" }, "quantity":{ "format":"double", "type":"number" }, "purchaseChargeAdjustment":{ "format":"double", "type":"number" }, "usageChargeAdjustment":{ "format":"double", "type":"number" }, "cycleChargeAdjustment":{ "format":"double", "type":"number" }, "purchaseMode":{ "$ref":"#/components/schemas/PurchaseModeJXB" }, "gracePeriodOffset":{ "type":"integer" }, "gracePeriodUnit":{ "$ref":"#/components/schemas/GracePeriodUnitJXB" }, "addOnOfferingValidityMode":{ "$ref":"#/components/schemas/AddOnOfferingValidityModeJXB" }, "baseChargeOfferingName":{ "type":"string" }, "chargeOfferingName":{ "type":"string" }, "alterationOfferingName":{ "type":"string" }, "prorationBasedOn":{ "$ref":"#/components/schemas/ProrationBasedOnJXB" } }, "type":"object" }, "ValidityJXB":{ "properties":{ "offset":{ "type":"integer" }, "unit":{ "$ref":"#/components/schemas/ValidityOffsetUnitJXB" }, "mode":{ "$ref":"#/components/schemas/ValidityModeJXB" } }, "type":"object" }, "PurchaseModeJXB":{ "enum":[ "EXTEND", "EXTEND_NEW_SUB_BAL", "LONGEST_DATE", "LONGEST_DATE_NEW_SUB_BAL", "NEW_INSTANCE", "OVERWRITE" ], "type":"string" }, "GracePeriodUnitJXB":{ "enum":[ "DAY", "HOUR", "MINUTE", "SECOND" ], "type":"string" }, "AddOnOfferingValidityModeJXB":{ "enum":[ "BASE_OFFER", "BASE_OFFER_EXPIRY_FIRST", "BASE_OFFER_EXPIRY_LAST", "BASE_OR_ADD_ON_OFFER_EXPIRY_FIRST", "BASE_OR_ADD_ON_OFFER_EXPIRY_LAST" ], "type":"string" }, "ProrationBasedOnJXB":{ "enum":[ "PRORATE_30_DAYS", "PRORATE_DAYS_IN_MONTH" ], "type":"string" }, "ValidityOffsetUnitJXB":{ "enum":[ "CYCLE", "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ], "type":"string" }, "ValidityModeJXB":{ "enum":[ "FIRST_USAGE", "NOW_TO_NEVER", "RELATIVE" ], "type":"string" }, "TermTimeUnitJXB":{ "enum":[ "DAY", "MONTH", "WEEK", "YEAR" ], "type":"string" }, "EarlyTerminationOptionJXB":{ "enum":[ "ALLOWED_NO_PENALTY", "ALLOWED_WITH_PENALTY", "NOT_ALLOWED" ], "type":"string" }, "ApplyPenaltyRuleJXB":{ "enum":[ "CONTRACT_BALANCE", "FULL_CHARGE", "USED_CONTRACT_UNITS" ], "type":"string" }, "OfferTypeJXB":{ "enum":[ "AGGREGATION", "ITEM", "SUBSCRIPTION", "SYSTEM" ], "type":"string", "description":"Refers to the type of the charge offer allowed. The default offer type is SUBSCRIPTION. Note that AGGREGATION is not a valid offerType for the charge offering." }, "DistributionEventMapJXB":{ "properties":{ "eventName":{ "type":"string" }, "validIfCancelled":{ "type":"boolean" }, "validIfInactive":{ "type":"boolean" }, "distributionRatePlanInfo":{ "$ref":"#/components/schemas/RatePlanInfoJXB" }, "distributionRatePlanName":{ "type":"string" }, "ratePlanIID":{ "type":"string" } }, "type":"object" }, "RatePlanInfoJXB":{ "properties":{ "targetEngine":{ "items":{ "type":"string" }, "type":"array" } }, "type":"object" }, "ApplicableChargeAndQuantityJXB":{ "enum":[ "ORIGINAL_CHARGE", "REMAINING_CHARGE", "UNUSED_CHARGE_QUANTITY" ], "type":"string" }, "AlterationEventMapJXB":{ "properties":{ "eventName":{ "type":"string" }, "validIfCancelled":{ "type":"boolean" }, "validIfInactive":{ "type":"boolean" }, "snowball":{ "type":"boolean" }, "validAtStartNotValidAtEnd":{ "$ref":"#/components/schemas/AlterationProrationValueJXB" }, "notValidAtStartValidAtEnd":{ "$ref":"#/components/schemas/AlterationProrationValueJXB" }, "notValidAtStartNotValidAtEnd":{ "$ref":"#/components/schemas/AlterationProrationValueJXB" }, "alterationRatePlanInfo":{ "$ref":"#/components/schemas/RatePlanInfoJXB" }, "alterationRatePlanSelectorInfo":{ "$ref":"#/components/schemas/RatePlanSelectorInfoJXB" }, "alterationRatePlanName":{ "type":"string" }, "alterationRatePlanSelectorName":{ "type":"string" }, "ratePlanIID":{ "type":"string" }, "ratePlanSelIID":{ "type":"string" } }, "type":"object" }, "PriceTagWithDefaultJXB":{ "required":[ "attributeName", "tagName", "tagScope" ], "properties":{ "attributeName":{ "type":"string", "title":"price tag attribute name", "description":"Refers to the attribute's name. It specifies whether the price tag is applied on the price (for balance impacts in rate plan and increment) or lower bound/upper bound (for quantity ranges in usage/onetime/recurring events)." }, "tagName":{ "type":"string", "title":"price tag name", "description":"Refers to the name of the price tag configured with the charge offer." }, "tagScope":{ "$ref":"#/components/schemas/PriceTagScopeJXB", "description":"Refers to the price tag's scope. The default value is Event Profile." }, "description":{ "type":"string", "title":"price tag description", "description":"Describes the price tag configured with the charge offer." }, "defaultValue":{ "type":"string", "title":"price tag default value", "description":"Refers to the default value of the price tag." }, "count":{ "format":"int64", "type":"integer", "title":"price tag count in charge offer", "description":"Refers to the count of the price tag associated in rate plans." } }, "type":"object", "description":"A price tag can be used to tag applicable pricing attributes at the design time which then can be used at rating time to impact a different price." }, "PriceTagScopeJXB":{ "enum":[ "EVENT_PROFILE" ], "type":"string", "description":"Refers to the price tag's scope. The default value is Event Profile." }, "AlterationProrationValueJXB":{ "enum":[ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ], "type":"string" }, "RatePlanSelectorInfoJXB":{ "properties":{ "targetEngine":{ "items":{ "type":"string" }, "type":"array" } }, "type":"object" }, "ApplicableQuantityJXB":{ "enum":[ "ORIGINAL", "REMAINING" ], "type":"string", "description":"Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer." }, "DateRangeImpactTypeJXB":{ "enum":[ "EVENT_DATE", "INSTANTIATED_DATE", "PURCHASE_DATE" ], "type":"string", "description":"Sets the impact type when balance impacts are added with new date ranges to an existing charge offer. It specifies whether the existing subscriptions move to the new balance impact or continue with the old balance impact." }, "ChargeOfferDeliverableJXB":{ "required":[ "deliverableName" ], "properties":{ "deliverableName":{ "type":"string", "title":"deliverable name", "description":"The deliverable's name." }, "deliverableIID":{ "type":"string", "title":"deliverable id", "description":"The deliverable's internal ID." } }, "type":"object", "description":"Refers to a deliverable used by a charge offering. Deliverables specify when and how much revenue can a customer's purchase of the products and services recognise." }, "RetryUnitJXB":{ "enum":[ "DAY", "HOUR", "MINUTE", "MONTH", "SECOND", "WEEK", "YEAR" ], "type":"string", "description":"Refers to the retrial frequency's measurment unit. The default value is day. This is applicable when the credit limit is set as AUTO_RENEW_CANCEL, RENTAL_FAILURE, or INSUFFICIENT_BALANCE." }, "ValidityRoundingModeJXB":{ "enum":[ "NOT_SET", "OFF", "ON" ], "type":"string", "description":"Specifies whether to start the charge offer's validity period at the purchase time or at midnight of the purchase day. The default value is NOT_SET." }, "ScaleRoundingModeJXB":{ "enum":[ "OFF", "ON" ], "type":"string", "description":"Specifies whether to calculate the scale based on validityRounding." }, "ChargeEventMapJXB":{ "required":[ "eventName", "validIfCancelled", "validIfInactive", "timezoneMode", "minQuantity", "minQuantityUnit", "incrementQuantity", "incrementQuantityUnit", "roundingMode", "prorateFirst", "prorateLast" ], "properties":{ "eventName":{ "type":"string", "title":"charge event name", "description":"Refers to the event's name." }, "validIfCancelled":{ "type":"boolean", "title":"charge valid if canceled", "description":"Specifies to charge even if the instantiated product offering status is canceled. The default value is true." }, "validIfInactive":{ "type":"boolean", "title":"charge valid if inactive", "description":"Specifies to charge even if the instantiated product offering status is inactive. The default value is true." }, "validIfSuspendedActive":{ "type":"boolean", "title":"charge valid if suspended active", "description":"Specifies to charge even if the instantiated product offering status is suspended but active. The default value is true." }, "rum":{ "type":"string", "title":"rum name", "description":"The name of the RUM. RUMs specify the units used to measure an event and how to calculate the measurement." }, "description":{ "type":"string", "title":"charge event description", "description":"Describes the charge event map configured." }, "timezoneMode":{ "title":"charge event timezone mode", "description":"Determines the time zone used to rate an event. Possible values are account, event and server.", "$ref":"#/components/schemas/TimeZoneModeJXB" }, "minQuantity":{ "type":"number", "title":"rum min round quantity", "description":"Refers to the minimum value that the RUM quantity is rounded to. The minimum quantity starts from 0 by default." }, "minQuantityUnit":{ "type":"string", "title":"rum min quantity unit", "description":"Refers to the unit in which the minimum quantity is expressed. Possible values are none, second, minute, hour, day." }, "incrementQuantity":{ "type":"number", "title":"rum round increment quantity", "description":"Refers to the incremental value to round the RUM quantity to. The RUM quantity is always rounded to an integral multiple of the Incremental Quantity. For example, if the Increment Quantity is configured as 30 for a RUM of seconds, then the amount to rate will be rounded to that increment (see roundingMode) and a 43 second call will be rated as 60 seconds (if rounding up) or 30 seconds (if rounding down)." }, "incrementQuantityUnit":{ "type":"string", "title":"rum round increment quantity unit", "description":"Refers to the units that increment quantity is specified in. Possible values are ." }, "roundingMode":{ "title":"rum quantity rounding mode", "description":"Specifies how the RUM quantity is rounded. Possible values are down, nearest, up.", "$ref":"#/components/schemas/RoundingModeJXB" }, "prorateFirst":{ "title":"charge purchase prorate first", "description":"Specifies how to apply cycle fees and rollovers when customers purchase subscriptions in the middle of their billing cycle. Possible values are FULL_CHARGE, NOT_APPLICABLE, NO_CHARGE, PRORATE_CHARGE.", "$ref":"#/components/schemas/ProrationValueJXB" }, "prorateLast":{ "title":"charge cancel prorate last", "description":"Specifies how to apply cycle fees and rollovers when customers cancel subscriptions in the middle of their billing cycle. Possible values are FULL_CHARGE, NOT_APPLICABLE, NO_CHARGE, PRORATE_CHARGE.", "$ref":"#/components/schemas/ProrationValueJXB" }, "prorateCycle":{ "title":"charge change dom prorate cycle", "description":"Specifies how to apply cycle fees when customers change their billing day of the month (DOM) during any billing cycle.", "$ref":"#/components/schemas/ProrationValueJXB" }, "chargeRatePlanInfo":{ "title":"charge rate plan info", "description":"Indicates the rating engine(s) the charge rate plan is published to.", "$ref":"#/components/schemas/ChargeRatePlanInfoJXB" }, "chargeRatePlanSelectorName":{ "type":"string", "title":"(required*) charge rate plan selector name", "description":"Refers to the charge selector's name. One of the fields chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive.." }, "chargeRatePlanName":{ "type":"string", "title":"(required*) charge rate plan name", "description":"Refers to the name of the charge configuration inside the charge offer at a granular and more detailed level. One of the fields chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive." }, "rolloverRatePlanName":{ "type":"string", "title":"(required*) rollover rate plan name", "description":"Refers to the rollover rate plan's name. One of the fiels chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive." }, "ratePlanIID":{ "type":"string", "title":"rate plan id", "description":"The charge rate plan's ID generated internally by the PDC system for the charge event map." }, "ratePlanSelIID":{ "type":"string", "title":"rate plan selector id", "description":"The charge selector's ID generated internally by the PDC system for the charge event map." } }, "type":"object" }, "TimeZoneModeJXB":{ "enum":[ "ACCOUNT", "EVENT", "SERVER" ], "type":"string", "description":"Determines the time zone used to rate an event." }, "RoundingModeJXB":{ "enum":[ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ], "type":"string", "description":"Specifies how a RUM quantity is rounded." }, "ProrationValueJXB":{ "enum":[ "FULL_CHARGE", "NOT_APPLICABLE", "NO_CHARGE", "PRORATE_CHARGE" ], "type":"string", "description":"Specifies how to apply cycle fee or rollover when a customer makes changes to subscription in the middle of the billing cycle." }, "ChargeRatePlanInfoJXB":{ "properties":{ "targetEngine":{ "items":{ "type":"string" }, "type":"array", "title":"charge rate plan target engine", "description":"Refers to the target engine where the information about the charge offer is to be published." } }, "type":"object", "description":"Indicates to which rating engine(s) the charge rate plan is published." }, "AAStereoTypeJXB":{ "enum":[ "ALTERATION_RATE_PLAN_SELECTOR", "APN_MAP", "ATTRIBUTE_ANALYZER_MODEL", "CHARGE_RATE_PLAN_SELECTOR", "GENERIC_SELECTOR", "PRICE_MODEL_SELECTOR", "TAX_EXEMPTION_SELECTOR", "TAX_SELECTOR", "USC_MAP" ], "type":"string", "description":"Specifies the type of selector." }, "AAValidityPeriodJXB":{ "properties":{ "validFrom":{ "type":"string" }, "rule":{ "items":{ "$ref":"#/components/schemas/AARuleJXB" }, "type":"array" } }, "type":"object" }, "AAModelDataJXB":{ "properties":{ "description":{ "type":"string" }, "key":{ "type":"string" }, "value":{ "type":"string" } }, "type":"object" }, "AARuleJXB":{ "properties":{ "name":{ "type":"string" }, "ruleData":{ "items":{ "$ref":"#/components/schemas/AARuleDataJXB" }, "type":"array" }, "result":{ "items":{ "$ref":"#/components/schemas/AAResultJXB" }, "type":"array" }, "namedResultExpression":{ "items":{ "$ref":"#/components/schemas/NamedResultExpressionJXB" }, "type":"array" }, "customExpression":{ "items":{ "$ref":"#/components/schemas/CustomExpressionJXB" }, "type":"array" }, "fieldToValueExpression":{ "items":{ "$ref":"#/components/schemas/FieldToValueExpressionJXB" }, "type":"array" }, "fieldToFieldExpression":{ "items":{ "$ref":"#/components/schemas/FieldToFieldExpressionJXB" }, "type":"array" }, "valueMapExpression":{ "items":{ "$ref":"#/components/schemas/ValueMapExpressionJXB" }, "type":"array" }, "crSelectorExpression":{ "items":{ "$ref":"#/components/schemas/CRSelectorExpressionJXB" }, "type":"array" }, "complexAAExpression":{ "items":{ "$ref":"#/components/schemas/ComplexAAExpressionJXB" }, "type":"array" } }, "type":"object" }, "AARuleDataJXB":{ "properties":{ "description":{ "type":"string" }, "key":{ "type":"string" }, "value":{ "type":"string" } }, "type":"object" }, "AAResultJXB":{ "properties":{ "resultName":{ "type":"string" }, "resultData":{ "items":{ "$ref":"#/components/schemas/AAResultDataJXB" }, "type":"array" } }, "type":"object" }, "NamedResultExpressionJXB":{ "properties":{ "namedResult":{ "items":{ "type":"string" }, "type":"array" } }, "type":"object" }, "CustomExpressionJXB":{ "properties":{ "functionName":{ "type":"string" } }, "type":"object" }, "FieldToValueExpressionJXB":{ "properties":{ "operation":{ "$ref":"#/components/schemas/OperatorJXB" }, "seperator":{ "type":"string" }, "fieldName":{ "type":"string" }, "fieldValue":{ "type":"string" }, "fieldKind":{ "$ref":"#/components/schemas/FieldKindJXB" } }, "type":"object" }, "FieldToFieldExpressionJXB":{ "properties":{ "operation":{ "$ref":"#/components/schemas/OperatorJXB" }, "seperator":{ "type":"string" }, "lhsFieldName":{ "type":"string" }, "rhsFieldName":{ "type":"string" }, "lhsFieldKind":{ "$ref":"#/components/schemas/FieldKindJXB" }, "rhsFieldKind":{ "$ref":"#/components/schemas/FieldKindJXB" } }, "type":"object" }, "ValueMapExpressionJXB":{ "properties":{ "operation":{ "$ref":"#/components/schemas/OperatorJXB" }, "seperator":{ "type":"string" }, "valueMapName":{ "type":"string" }, "zoneModelName":{ "type":"string" }, "fieldName":{ "type":"string" }, "mappedValue":{ "type":"string" }, "fieldKind":{ "$ref":"#/components/schemas/FieldKindJXB" } }, "type":"object" }, "CRSelectorExpressionJXB":{ "properties":{ "leftOperand":{ "type":"string" }, "rightOperand":{ "type":"string" }, "operator":{ "$ref":"#/components/schemas/LogicalOperatorJXB" } }, "type":"object" }, "ComplexAAExpressionJXB":{ "properties":{ "leftOperand":{ "$ref":"#/components/schemas/AttributeAnalyzerExpressionsJXB" }, "rightOperand":{ "$ref":"#/components/schemas/AttributeAnalyzerExpressionsJXB" }, "operator":{ "$ref":"#/components/schemas/LogicalOperatorJXB" } }, "type":"object" }, "AttributeAnalyzerExpressionsJXB":{ "properties":{ "namedResultExpression":{ "$ref":"#/components/schemas/NamedResultExpressionJXB" }, "customExpression":{ "$ref":"#/components/schemas/CustomExpressionJXB" }, "fieldToValueExpression":{ "$ref":"#/components/schemas/FieldToValueExpressionJXB" }, "fieldToFieldExpression":{ "$ref":"#/components/schemas/FieldToFieldExpressionJXB" }, "valueMapExpression":{ "$ref":"#/components/schemas/ValueMapExpressionJXB" }, "crSelectorExpression":{ "$ref":"#/components/schemas/CRSelectorExpressionJXB" }, "complexAAExpression":{ "$ref":"#/components/schemas/ComplexAAExpressionJXB" } }, "type":"object" }, "LogicalOperatorJXB":{ "enum":[ "AND", "NONE", "NOT", "OR" ], "type":"string" }, "OperatorJXB":{ "enum":[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "MAPS_TO", "NOT_EQUAL_TO", "REGEX" ], "type":"string" }, "FieldKindJXB":{ "enum":[ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ], "type":"string" }, "AAResultDataJXB":{ "properties":{ "description":{ "type":"string" }, "key":{ "type":"string" }, "value":{ "type":"string" } }, "type":"object" }, "RolloverRateDateRangeJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "startDate":{ "type":"string" }, "endDate":{ "type":"string" }, "rolloverPopModel":{ "$ref":"#/components/schemas/RolloverPopModelJXB" } }, "type":"object" }, "RolloverPopModelJXB":{ "required":[ "rolloverCharge" ], "properties":{ "rolloverCharge":{ "items":{ "$ref":"#/components/schemas/RolloverPopJXB" }, "type":"array", "title":"rollover charge", "description":"Defines the rollover product offering price." } }, "type":"object", "description":"Defines the rollover product offering price model." }, "RolloverPopJXB":{ "required":[ "unitOfMeasure", "balanceElementNumCode", "rolloverUnits", "rolloverMaxUnits" ], "properties":{ "glid":{ "format":"int32", "type":"integer", "title":"glid", "description":"Refers to the general ledger's ID. It is used for selecting the required general ledger information for a given balance impact." }, "unitOfMeasure":{ "$ref":"#/components/schemas/RolloverUnitOfMeasureJXB", "title":"unit of measure", "description":"Configures the frequency of the rollover. For example, monthly, days, years. Possible values are days, months, weeks, years." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Refers to the balance element's numeric code. For example, 840 for USD." }, "rolloverUnits":{ "format":"double", "type":"number", "title":"rollover units", "description":"Specifies the quantity to rollover per period." }, "rolloverMaxUnits":{ "format":"double", "type":"number", "title":"rollover max units", "description":"Specifies the maximum quantity that can be rolled over." }, "rolloverCount":{ "type":"integer", "title":"rollover count", "description":"Specifies the maximum number of periods to rollover. The default value 1." } }, "type":"object", "description":"Defines the rollover product offering price." }, "RolloverUnitOfMeasureJXB":{ "enum":[ "DAYS", "MONTHS", "WEEKS", "YEARS" ], "type":"string", "description":"Configures the frequency of rollover. For example, monthly, days, years. Possible values are days, months, weeks, years." }, "DistributionDateRangeRPEBranchJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "startDate":{ "type":"string" }, "endDate":{ "type":"string" }, "drpDateRange":{ "items":{ "$ref":"#/components/schemas/DistributionDateRangeRPEBranchJXB" }, "type":"array" }, "distributionConfiguration":{ "items":{ "$ref":"#/components/schemas/DistributionRPEBranchJXB" }, "type":"array" }, "distributionPopModelName":{ "type":"string" }, "drpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" } }, "type":"object" }, "DistributionRPEBranchJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "triggerSpecName":{ "type":"string" }, "chargeSelectorSpecName":{ "items":{ "type":"string" }, "type":"array" }, "drpDateRange":{ "items":{ "$ref":"#/components/schemas/DistributionDateRangeRPEBranchJXB" }, "type":"array" }, "distributionConfiguration":{ "items":{ "$ref":"#/components/schemas/DistributionRPEBranchJXB" }, "type":"array" }, "distributionPopModelName":{ "type":"string" }, "drpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" } }, "type":"object" }, "CompositePopModelRPEJXB":{ "required":[ "name" ], "properties":{ "name":{ "type":"string", "title":"name", "description":"Refers to the name of the composite product offering price model rate plan. It is transfromed as rate_tag name used by the Batch Rating Engine." }, "description":{ "type":"string", "title":"description", "description":"Describes the composite product offering price model rate plan." }, "alterationPopModel":{ "$ref":"#/components/schemas/AlterationPopModelJXB", "title":"(required*) alteration pop model", "description":"Defines the alteration product offering price model. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." }, "oneTimePopModel":{ "$ref":"#/components/schemas/OneTimePopModelJXB", "title":"(required*) one time pop model", "description":"Defines the balance impacts for a one time event type. For example, Product Purchase Fee, Product Cancel Fee, and so on. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." }, "recurringPopModel":{ "$ref":"#/components/schemas/RecurringPopModelJXB", "title":"(required*) recurring pop model", "description":"Defines the balance impacts for a recurring event type. For example, Monthly Cycle Forward fee. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." }, "replacementPopModel":{ "$ref":"#/components/schemas/ReplacementPopModelJXB", "title":"(required*) replacement pop model", "description":"Defines the replacement product offering price model. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." }, "rolloverPopModel":{ "$ref":"#/components/schemas/RolloverPopModelJXB", "title":"(required*) rollover pop model", "description":"Defines the rollover product offering price model. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." }, "usageChargePopModel":{ "$ref":"#/components/schemas/UsageChargePopModelJXB", "title":"(required*) usage charge pop model", "description":"Defines the usage charge for the product offering price model. It is a required field and has to be one of alterationPopModel, oneTimePopModel, recurringPopModel, replacementPopModel, rolloverPopModel, or usageChargePopModel." } }, "type":"object", "description":"Refers to the generic product offering price model. It can be one-time, recurring, or usage type." }, "AlterationPopModelJXB":{ "required":[ "priceTier" ], "properties":{ "priceTier":{ "$ref":"#/components/schemas/AlterationPriceTierJXB", "title":"price tier", "description":"Refers to the container object to define the alteration price tier." } }, "type":"object", "description":"Defines the alteration product offering price model." }, "OneTimePopModelJXB":{ "required":[ "priceTier" ], "properties":{ "priceTier":{ "$ref":"#/components/schemas/OneTimePriceTierJXB", "title":"price tier", "description":"Defines the one time price tier." } }, "type":"object", "description":"Defines the balance impacts for a one time event type. For example, Product Purchase Fee, Product Cancel Fee>/b>, and so on." }, "RecurringPopModelJXB":{ "required":[ "priceTier" ], "properties":{ "priceTier":{ "$ref":"#/components/schemas/RecurringPriceTierJXB", "title":"price tier" } }, "type":"object", "description":"Defines the balance impacts for a recurring event type. For example, Monthly Cycle Forward fee." }, "ReplacementPopModelJXB":{ "required":[ "replacementCharge" ], "properties":{ "replacementCharge":{ "$ref":"#/components/schemas/ReplacementPopJXB", "title":"replacement charge", "description":"Defines the replacement product offering price." } }, "type":"object", "description":"Defines the replacement producting offer price model." }, "UsageChargePopModelJXB":{ "required":[ "priceTier" ], "properties":{ "priceTier":{ "items":{ "$ref":"#/components/schemas/ChargePriceTierJXB" }, "type":"array", "title":"price tier", "description":"Defines the charge price tier." } }, "type":"object", "description":"Defines the usage charge product offering price model." }, "ChargePriceTierJXB":{ "required":[ "distributionMethod", "rumName", "priceTierValidityPeriod", "applicableQuantity" ], "properties":{ "distributionMethod":{ "$ref":"#/components/schemas/DistributionMethodJXB", "title":"distribution method", "description":"Specifies how the basis value will be distributed across tiers. Specifies whether to pick the quantity range containing the value or to distribute the values across applicable quantity ranges. Possible values are FROM_BAL_IMPACT, NONE." }, "tierBasis":{ "$ref":"#/components/schemas/ChargeTierExpressionJXB", "title":"tier basis", "description":"Refers to the container object to define charge tier expression." }, "enforceCreditLimit":{ "$ref":"#/components/schemas/CreditLimitJXB", "title":"enforce credit limit", "description":"Indicates whether to enforce the credit limit. Enforce credit limit and minimum charge are required and they are mutually exclusive." }, "rumName":{ "type":"string", "title":"rum name", "description":"The RUM's name." }, "currencyCode":{ "type":"string", "title":"currency code", "description":"Refers to the three letter ISO code for the currency." }, "priceTierValidityPeriod":{ "items":{ "$ref":"#/components/schemas/PriceTierValidityPeriodJXB" }, "type":"array", "title":"price tier validity period", "description":"Defines the charge price tier validity period structure." }, "applicableQuantity":{ "$ref":"#/components/schemas/ApplicableQuantityJXB", "title":"applicable quantity", "description":"Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer." } }, "type":"object", "description":"Defines the charge price tier." }, "DistributionMethodJXB":{ "enum":[ "FROM_BAL_IMPACT", "NONE" ], "type":"string", "description":"Specifies how the basis value will be distributed across the tiers. It specifies whether to pick the quantity range containing the value or to distribute the value across applicable quantity ranges. Possible values are FROM_BAL_IMPACT, NONE." }, "ChargeTierExpressionJXB":{ "properties":{ "rumTierExpression":{ "$ref":"#/components/schemas/RumChargeTierExpressionJXB", "title":"(required*) rum tier expression", "description":"Refers to the tier expression for the RUM quantity. It is a required field and has to be either rumTierExpression or balanceTierExpression." }, "balanceTierExpression":{ "$ref":"#/components/schemas/BalanceChargeTierExpressionJXB", "title":"(required*) balance tier expression", "description":"Refers to the tier expression for balance. It is a required field and has to be either rumTierExpression or balanceTierExpression." } }, "type":"object", "description":"Refers to the base abstract entity for the tier expression." }, "CreditLimitJXB":{ "enum":[ "AUTO_RENEW_CANCEL", "DEDUCT_RENTAL", "DEFAULT", "INSUFFICIENT_BALANCE", "LOAN", "NORMAL", "OUTSTANDING_AMOUNT", "RENTAL_FAILURE", "SKIP_CYCLE" ], "type":"string", "description":"Specifies how to enforce credit limits or let customers exceed them. The default value is NORMAL implying to enforce the credit limit." }, "PriceTierValidityPeriodJXB":{ "required":[ "lowerBound", "validFrom", "priceTierRange" ], "properties":{ "minimumCharge":{ "items":{ "$ref":"#/components/schemas/MinimumChargeJXB" }, "type":"array", "title":"minimum charge", "description":"Defines a minimum charge configuration for a balance element." }, "lowerBound":{ "type":"string", "title":"lower bound", "description":"The starting value for the range. The default value is 0." }, "validFrom":{ "type":"string", "title":"valid from", "description":"Defines the start of the validity period. The format is YYYYMMDDTHHMMSS and the default value is 0/inf." }, "priceTierRange":{ "items":{ "$ref":"#/components/schemas/ChargePriceTierRangeJXB" }, "type":"array", "title":"price tier range", "description":"Defines the charge price tier range." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which can then be used at rating time to impact different prices. All elements are required except description." } }, "type":"object", "description":"Defines the charge price tier validity period structure." }, "MinimumChargeJXB":{ "properties":{ "value":{ "format":"double", "type":"number", "title":"value", "description":"Defines the minimum charge value for a balance element." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Refers to the balance element's numeric code. For example, 840 for USD." } }, "type":"object", "description":"Defines a minimum charge configuration for a balance element." }, "ChargePriceTierRangeJXB":{ "properties":{ "upperBound":{ "type":"string", "title":"(required*) upper bound", "description":"Refers to the end value for the range. It is supported for backward compatibility. It is a required field and has to be either upperBound or upperBoundExpression." }, "upperBoundExpression":{ "$ref":"#/components/schemas/ChargeTierBoundExpressionJXB", "title":"(required*) upper bound expression", "description":"Defines the end value for a quantity range or the noncurrency balance element to consume. It is a required field and has to be either upperBound or upperBoundExpression." }, "fixedCharge":{ "items":{ "$ref":"#/components/schemas/FixedChargePopJXB" }, "type":"array", "title":"(required*) fixed charge", "description":"Defines the fixed charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge." }, "scaledCharge":{ "items":{ "$ref":"#/components/schemas/ScaledChargePopJXB" }, "type":"array", "title":"(required*) scaled charge", "description":"Defines the scaled charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at the design time which can then be used at rating time to impact different price. All elements are required except description." } }, "type":"object", "description":"Defines the charge price tier range." }, "PriceTagJXB":{ "required":[ "attributeName", "tagName", "tagScope" ], "properties":{ "attributeName":{ "type":"string", "title":"attribute name", "description":"Refers to the attribute's name. It specifies whether the price tag is applied on price (for balance impacts in rate plan and increment) or to lower bound/upper bound (for quantity ranges in usage/onetime/recurring events)." }, "tagName":{ "type":"string", "title":"tag name", "description":"Refers to the name of the price tag configured with the charge offer." }, "tagScope":{ "$ref":"#/components/schemas/PriceTagScopeJXB", "title":"tag scope", "description":"Refers to the price tag's scope. The default scope is Event Profile." }, "description":{ "type":"string", "title":"description", "description":"Describes the price tag configured with the charge offer." } }, "type":"object", "description":"Tags any pricing attribute at design time which can then be used at rating time to impact different price. All elements are required except description." }, "ChargeTierBoundExpressionJXB":{ "properties":{ "numberTBExpression":{ "$ref":"#/components/schemas/NumberChargeTBExpressionJXB", "title":"(required*) number tier bound expression", "description":"It is a required field and must be either numberTBExpression or balanceTBExpression. Refers to the number expression for charge tier bound." }, "balanceTBExpression":{ "$ref":"#/components/schemas/BalanceChargeTBExpressionJXB", "title":"(required*) balance tier bound expression", "description":"Refers to the tier bound expression for balance. It is a required field and must be either numberTBExpression or balanceTBExpression." } }, "type":"object", "description":"Defines the end value for a quantity range or the noncurrency balance element to consume." }, "FixedChargePopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "priceType" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"Refers to the amount of debit or credit. For example 10 USD/GB/MIN." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"Refers to the type of unit to which the charge applies. Possible values are NONE, MINUTES, SECONDS, DAYS, HOURS, BYTES, GBYTES, BMYTES, MBYTES." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Refers to the balance element's numeric code. For example, 840 for USD." }, "discountable":{ "type":"boolean", "title":"discountable", "description":"Refers to the boolean flag to make a balance impact discountable. The default value is False." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"Refers to the type of impact. It can be grant, consumption or aggregation." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"Refers to the time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"Refers to the tax code used for the discount." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"Refers to the the tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector ID", "description":"Refers to the tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"general ledger ID", "description":"Refers to the General Ledger's ID. It is used for selecting the required General Ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "periodConditionExpression":{ "$ref":"#/components/schemas/PeriodConditionExpressionJXB", "title":"period condition expression", "description":"Defines the period condition expression." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which can then be used at rating time to impact a different price. All elements are required except description." } }, "type":"object", "description":"Defines the fixed charge product offering price." }, "ScaledChargePopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "priceType" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"price", "description":"Refers to the amount of debit or credit. For example 10 USD/GB/MIN." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"Refers to the type of unit to which the pricing applies. For example minute, byte." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Refers to the balance element's numeric code. For example, 840 for USD." }, "discountable":{ "type":"boolean", "title":"discountable", "description":"Refers to the boolean flag to make a balance impact discountable. The default value is False." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"Refers to the type of impact. It can be grant, consumption or aggregation." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"Refers to the time when the charge is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"Refers to the tax code used for the discount." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"Refers to the tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector id", "description":"Refers to the tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"general ledger ID", "description":"Refers to the General Ledger's ID. It is used for selecting the required General Ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "incrementStep":{ "format":"float", "type":"number", "title":"increment step", "description":"Specifies the smallest increment step size on which the scaled impact should be calculated (beat). The default Value is 1." }, "incrementRounding":{ "$ref":"#/components/schemas/IncrementRoundingJXB", "title":"increment rounding", "description":"Specifies the rounding method for the increment step. The valid values are 0 - None, 1 - Up and 2 -Down. The default value is 0." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which can then be used at rating time to impact a different price. All elements are required except description." } }, "type":"object", "description":"Defines the scaled charge product offering price." }, "UnitOfMeasureJXB":{ "enum":[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ], "type":"string", "description":"Refers to the type of unit to which the pricing applies. For example minute, byte." }, "PriceTypeJXB":{ "enum":[ "AGGREGATION", "CONSUMPTION", "GRANT" ], "type":"string", "description":"Refers to the impact type." }, "TaxTimeJXB":{ "enum":[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ], "type":"string", "description":"Refers to the time when the charge is taxed." }, "PriceValidityJXB":{ "properties":{ "startValidityMode":{ "$ref":"#/components/schemas/StartValidityModeJXB", "title":"start validity mode", "description":"Defines the start validity mode for the price." }, "endValidityMode":{ "$ref":"#/components/schemas/EndValidityModeJXB", "title":"end validity model", "description":"Defines the end validity mode for the price." }, "validityRange":{ "type":"string", "title":"validity range", "description":"Defines the validity range. The DateTimeRange should be defined as YYYYMMDDTHHMMSS or YYYYMMDDTHHMMSS." }, "relativeStartOffset":{ "type":"integer", "title":"relative start offset", "description":"Makes the amount valid in any number of accounting cycles, billing cycles, months, days, hours, minutes, or seconds from the event occurrence. For example, if you specify two accounting cycles, the amount will be valid after two accounting cycles from when the event occurs." }, "relativeEndOffset":{ "type":"integer", "title":"relative end offset", "description":"The amount validity ends relative to the validity start time. Enter the number of accounting cycles, billing cycles, months, days, calendar days, hours, minutes, or seconds from the validity start time when the validity ends." }, "relativeStartOffsetUnit":{ "$ref":"#/components/schemas/OffsetUnitJXB", "title":"relative start offset unit", "description":"Refers to the offset unit to measure the relative start price validity." }, "relativeEndOffsetUnit":{ "$ref":"#/components/schemas/OffsetUnitJXB", "title":"relative end offset unit", "description":"Refers to the offset unit to measure the relative end price validity." }, "splitDetail":{ "$ref":"#/components/schemas/SplitDetailJXB", "title":"split detail", "description":"Defines the split details for the grant between start and end date." } }, "type":"object", "description":"Defines the validity period for the credited amount in the balance impact." }, "IncrementRoundingJXB":{ "enum":[ "DOWN", "NONE", "UP" ], "type":"string", "description":"Specifies the rounding method for the increment step. The valid values are 0 - None, 1 - Up and 2 -Down. The default value is 0." }, "StartValidityModeJXB":{ "enum":[ "ABSOLUTE", "FIRST_USAGE", "FOREVER", "IMMEDIATE", "PERIOD_START", "RELATIVE" ], "type":"string", "description":"Defines the start validity mode for the price." }, "EndValidityModeJXB":{ "enum":[ "ABSOLUTE", "NEVER", "RELATIVE_TO_PERIOD_START", "RELATIVE_TO_START" ], "type":"string", "description":"Defines the end validity mode for the price." }, "OffsetUnitJXB":{ "enum":[ "ACCOUNTING_CYCLE", "BEGIN_OF_DAY", "BILLING_CYCLE", "CALENDAR_DAY", "DAY", "EVENT_CYCLE", "HOUR", "MINUTE", "MONTH", "SECOND" ], "type":"string", "description":"Refers to the offset unit to measure the relative price validity cycle." }, "SplitDetailJXB":{ "required":[ "unitType", "validityType" ], "properties":{ "unit":{ "type":"integer", "title":"unit", "description":"Defines the split unit. It is a number in which the grant is split. The default value is -1. For example, in a split of 10 minutes, '10' is the unit and 'min' is the unit type." }, "unitType":{ "$ref":"#/components/schemas/SplitUnitTypeJXB", "title":"unit type", "description":"Defines the split unit type. the default value is HOUR." }, "validityType":{ "$ref":"#/components/schemas/SplitValidityTypeJXB", "title":"validity type", "description":"Defines the split validity type. The default value is BUCKET." } }, "type":"object", "title":"split detail", "description":"Defines the split details for the grant between the start and end date." }, "SplitUnitTypeJXB":{ "enum":[ "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ], "type":"string", "description":"Defines the split measurement unit." }, "SplitValidityTypeJXB":{ "enum":[ "BUCKET", "TOTAL" ], "type":"string", "description":"Defines the split validity type. The default value is BUCKET." }, "PeriodConditionExpressionJXB":{ "required":[ "unit", "value", "periodStartTime" ], "properties":{ "biConditionOperator":{ "$ref":"#/components/schemas/BIConditionOperatorJXB", "title":"bi-condition operator", "description":"Defines the balance impact condition operator." }, "unit":{ "$ref":"#/components/schemas/BIConditionUnitJXB", "title":"unit", "description":"Defines the unit of the Period Condition Expression." }, "value":{ "type":"integer", "title":"value", "description":"Defines the value of the Period Condition Expression." }, "periodStartTime":{ "$ref":"#/components/schemas/PeriodStartTimeJXB", "title":"period start time", "description":"Defines the Period Start Time." } }, "type":"object", "title":"period condition expression", "description":"Defines the Period Condition Expression." }, "BIConditionOperatorJXB":{ "enum":[ "EQUAL_TO" ], "type":"string", "description":"Defines the balance impact condition operator EQUAL TO." }, "BIConditionUnitJXB":{ "enum":[ "DAY", "HOUR" ], "type":"string", "description":"Defines the unit of the Period Condition Expression." }, "PeriodStartTimeJXB":{ "enum":[ "ALIGN_WITH_OFFER_START", "BEGIN_OF_CALENDAR_UNIT", "IMMEDIATE" ], "type":"string", "description":"Defines the Period Start Time." }, "NumberChargeTBExpressionJXB":{ "properties":{ "value":{ "type":"string", "title":"value", "description":"Refers to the numeric value for the tier bound. It is Float.POSITIVE_INFINITY for Inf and Float.NEGATIVE_INFINITY for -Inf." } }, "type":"object", "title":"number charge tier bound expression", "description":"Refers to the number expression for the charge tier bound." }, "BalanceChargeTBExpressionJXB":{ "properties":{ "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Defines the balance element's numeric code." } }, "type":"object", "title":"balance charge tier bound expression", "description":"Refers to the tier bound expression for balance." }, "RumChargeTierExpressionJXB":{ "type":"object", "description":"Refers to the tier expression base object for RUM quantity for charge." }, "BalanceChargeTierExpressionJXB":{ "properties":{ "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Defines the numeric code for the balance element." } }, "type":"object", "title":"balance charge tier expression", "description":"Refers to the tier expression for balance for a charge." }, "ReplacementPopJXB":{ "required":[ "type", "price", "balanceElementNumCode" ], "properties":{ "glid":{ "format":"int32", "type":"integer", "title":"General Ledger ID", "description":"Refers to the General Ledger's ID. It is used for selecting the required General Ledger Information for a given balance impact." }, "type":{ "$ref":"#/components/schemas/ReplacementTypeJXB", "title":"type", "description":"Specifies how the charge should be modified. The values are 0 - percentage, 1 -absolute value and 2 - replace with a specific value. For example ABSOULTE_VALUE, PERCENTAGE, REPLACEMENT_VALUE." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"Refers to the time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"Refers to the tax code used for the discount." }, "price":{ "format":"double", "type":"number", "title":"price", "description":"The amount of debit or credit. For example 10 USD/GB/MIN." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Refers to the balance element's numeric code. For example, 840 for USD." }, "rumName":{ "type":"string", "title":"rum name", "description":"The RUM's name." } }, "type":"object", "description":"Defines the replacement product offering price." }, "ReplacementTypeJXB":{ "enum":[ "ABSOLUTE_VALUE", "PERCENTAGE", "REPLACEMENT_VALUE" ], "type":"string", "description":"Specifies how the charge should be modified. The values are 0 - percentage, 1 -absolute value, and 2 - replace with a specific value. For example ABSOULTE_VALUE, PERCENTAGE, REPLACEMENT_VALUE." }, "RecurringPriceTierJXB":{ "required":[ "lowerBound", "tierBasis", "rumName", "tierRange" ], "properties":{ "lowerBound":{ "type":"string", "title":"lower bound", "description":"The starting value for the range. The default value is NO_MIN." }, "tierBasis":{ "$ref":"#/components/schemas/ChargeTierExpressionJXB", "title":"tier basis", "description":"The base abstract entity for the tier expression." }, "rumName":{ "type":"string", "title":"rum name", "description":"The RUM's name." }, "enforceCreditLimit":{ "$ref":"#/components/schemas/CreditLimitJXB", "title":"enforce credit limit", "description":"Specifies how to enforce credit limits or let customers exceed them. The default is NORMAL implying to enforce the credit limit." }, "creditLimitProrateQuantity":{ "type":"boolean", "title":"credit limit prorate quantity", "description":"If the service must be prorated according to the minimum amount. By default, this is set to true and the service will be prorated. Set this to false to grant the full service for the minimum amount." }, "tierRange":{ "items":{ "$ref":"#/components/schemas/RecurringPriceTierRangeJXB" }, "type":"array", "title":"tier range", "description":"Defines the recurring price tier range." } }, "type":"object", "description":"Defines the recurring price tier." }, "RecurringPriceTierRangeJXB":{ "required":[ "upperBound", "recurringCharge" ], "properties":{ "upperBound":{ "type":"string", "title":"upper bound", "description":"Refers to the maximum value of the range. It supports expressions." }, "recurringCharge":{ "items":{ "$ref":"#/components/schemas/RecurringChargePopJXB" }, "type":"array", "title":"recurring charge", "description":"Defines the recurring charge product offering price." } }, "type":"object", "description":"Defines the recurring price tier range." }, "RecurringChargePopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "priceType", "proratable", "impactType" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"price", "description":"The amount of debit or credit. For example 10 USD/GB/MIN." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"The type of unit to which the charge applies. Possible values are NONE, MINUTES, SECONDS, DAYS, HOURS, BYTES, GBYTES, BMYTES, MBYTES." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"The balance element's numeric code. For example, 840 for USD." }, "discountable":{ "type":"boolean", "title":"discountable", "description":"Makes a balance impact discountable. The default value is False." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"Refers to the type of impact. It can be grant, consumption or aggregation." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"The time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"The tax code used for the discount." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"The tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector ID", "description":"The tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"general ledger ID", "description":"The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "proratable":{ "type":"boolean", "title":"proratable", "description":"A boolean flag that sets proration. The default is true." }, "impactType":{ "$ref":"#/components/schemas/ImpactTypeJXB", "title":"impact type", "description":"Specifies whether the impact is fixed or scaled." }, "creditLimitMinimumAmount":{ "format":"double", "type":"number", "title":"credit limit mininum amount", "description":"The minimum amount for currency resources. By default, this is set to 0, which means the subscription fails if the balance is less than the full amount. It is not applicable for noncurrency resources." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which then can be used at rating time to impact different price. All elements are required except description." } }, "type":"object", "description":"Defines the recurring charge product offering price." }, "ImpactTypeJXB":{ "enum":[ "FIXED", "SCALED" ], "type":"string", "description":"Specifies whether the impact is fixed or scaled." }, "OneTimePriceTierJXB":{ "required":[ "lowerBound", "tierBasis", "rumName", "tierRange" ], "properties":{ "lowerBound":{ "type":"string", "title":"lower bound", "description":"The starting value for the range. The default value is 0." }, "tierBasis":{ "$ref":"#/components/schemas/ChargeTierExpressionJXB", "title":"tier basis", "description":"A container object that defines the charge tier expression." }, "rumName":{ "type":"string", "title":"rum name", "description":"Name of the RUM." }, "enforceCreditLimit":{ "$ref":"#/components/schemas/CreditLimitJXB", "title":"enforce credit limit", "description":"Specifies how to enforce credit limits or let customers exceed them. The default is NORMAL implying to enforce the credit limit." }, "creditLimitProrateQuantity":{ "type":"boolean", "title":"credit limit prorate quantity", "description":"Indicates whether to set prorate quantity if credit limit value is insufficient_balance. the default is true." }, "tierRange":{ "items":{ "$ref":"#/components/schemas/OneTimePriceTierRangeJXB" }, "type":"array", "title":"tier range", "description":"Defines the one time price tier range." } }, "type":"object", "title":"one time price tier", "description":"Defines the one time price tier." }, "OneTimePriceTierRangeJXB":{ "required":[ "upperBound", "oneTimeCharge" ], "properties":{ "upperBound":{ "type":"string", "title":"upper bound", "description":"The end value for the range. It is only supported for backward compatibility. The default value is NO_MAX." }, "oneTimeCharge":{ "items":{ "$ref":"#/components/schemas/OneTimeChargePopJXB" }, "type":"array", "title":"one time charge", "description":"The end value for the range. It is only supported for backward compatibility." } }, "type":"object", "title":"one time price tier range", "description":"The range of the one-time price tier." }, "OneTimeChargePopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "priceType" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"price", "description":"The amount to debit or credit." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"The type of unit to which the charge applies. Possible values are NONE, MINUTES, SECONDS, DAYS, HOURS, BYTES, GBYTES, BMYTES, MBYTES." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"The balance element's numeric code. For example, 840 for USD." }, "discountable":{ "type":"boolean", "title":"discountable", "description":"Makes a balance impact discountable. The default value is False." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"Refers to the type of impact. It can be grant or consumption." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"The time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"The tax code used for the discount." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"The tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector ID", "description":"The tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"General Ledger ID.", "description":"The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "impactType":{ "$ref":"#/components/schemas/ImpactTypeJXB", "title":"impact type", "description":"Specifies whether the impact is fixed or scaled." }, "creditLimitMinimumAmount":{ "format":"double", "type":"number", "title":"credit limit minimum amount", "description":"The minimum amount for currency resources. By default, this is set to 0, which means the subscription fails if the balance is less than the full amount. It is not applicable for noncurrency resources." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which then can be used at rating time to impact different price. All elements except are required except description." } }, "type":"object", "title":"one time charge pop", "description":"Refers to non recurring charges. For example, setup, cancellation fees." }, "AlterationPriceTierJXB":{ "required":[ "distributionMethod", "tierBasis", "lowerBound", "tierRange" ], "properties":{ "distributionMethod":{ "$ref":"#/components/schemas/DistributionMethodJXB", "title":"distribution method", "description":"Specifies how the basis value will be distributed across the tiers. Options include to pick the quantity range containing the value or distribute value across applicable quantity ranges. Possible values are FROM_BAL_IMPACT, NONE." }, "tierBasis":{ "$ref":"#/components/schemas/AlterationTierExpressionJXB", "title":"tier basis", "description":"The container object that defines alteration tier expression." }, "lowerBound":{ "$ref":"#/components/schemas/AlterationTierBoundExpressionJXB", "title":"lower bound", "description":"The base entity for alteration lower bound Expression." }, "tierRange":{ "items":{ "$ref":"#/components/schemas/AlterationPriceTierRangeJXB" }, "type":"array", "title":"tier range", "description":"The container object that defines the charge tier range." } }, "type":"object", "title":"alteration price tier", "description":"The container object that defines the alteration price tier." }, "AlterationTierExpressionJXB":{ "properties":{ "quantityTierExpression":{ "$ref":"#/components/schemas/QuantityAlterationBasisExpressionJXB", "title":"(required*) quantity tier expression", "description":"The tier basis expression for RUM quantity. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." }, "balanceTierExpression":{ "$ref":"#/components/schemas/BalanceAlterationBasisExpressionJXB", "title":"(required*) balance tier expression", "description":"The tier basis expression for balance. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." }, "chargeTierExpression":{ "$ref":"#/components/schemas/ChargeAlterationBasisExpressionJXB", "title":"(required*) charge tier expression", "description":"The tier basis expression for charge. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." }, "customTierExpression":{ "$ref":"#/components/schemas/CustomAlterationBasisExpressionJXB", "title":"(required*) custom tier expression", "description":"The user defined tier basis expression. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." }, "binaryTierExpression":{ "$ref":"#/components/schemas/BinaryAlterationBasisExpressionJXB", "title":"(required*) binary tier expression", "description":"The tier basis expression for binary operation. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." }, "numberTierExpression":{ "$ref":"#/components/schemas/NumberAlterationBasisExpressionJXB", "title":"(required*) number tier expression", "description":"The number expression for tier basis. This is a required field and has to be one of quantityTierExpression, balanceTierExpression, chargeTierExpression, customTierExpression, binaryTierExpression, or numberTierExpression." } }, "type":"object", "title":"alteration tier expression", "description":"The container object that defines alteration tier expression." }, "AlterationTierBoundExpressionJXB":{ "properties":{ "numberTBExpression":{ "$ref":"#/components/schemas/NumberAlterationTBExpressionJXB", "title":"(required*) number tier bound expression", "description":"The alteration tier bound expression for Number. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression." }, "balanceTBExpression":{ "$ref":"#/components/schemas/BalanceAlterationTBExpressionJXB", "title":"(required*) balance tier bound expression", "description":"The alteration tier bound expression for balance. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression" }, "customTBExpression":{ "$ref":"#/components/schemas/CustomAlterationTBExpressionJXB", "title":"(required*) custom tier bound expression", "description":"The user defined tier bound expression. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression" }, "binaryTBExpression":{ "$ref":"#/components/schemas/BinaryAlterationTBExpressionJXB", "title":"(required*) binary tier bound expression", "description":"The tier bound expression for binary operation. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression" }, "quantityTBExpression":{ "$ref":"#/components/schemas/QuantityAlterationTBExpressionJXB", "title":"(required*) quantity tier bound expression", "description":"The tier bound expression for RUM quantity. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression" }, "chargeTBExpression":{ "$ref":"#/components/schemas/ChargeAlterationTBExpressionJXB", "title":"(required*) charge tier bound expression", "description":"The tier bound expression for charge. This is a required field and has to be one of numberTBExpression, balanceTBExpression, customTBExpression, binaryTBExpression, quantityTBExpression, or chargeTBExpression" } }, "type":"object", "title":"alteration tier bound expression", "description":"The base entity for alteration lower bound expression." }, "AlterationPriceTierRangeJXB":{ "required":[ "upperBound" ], "properties":{ "upperBound":{ "$ref":"#/components/schemas/AlterationTierBoundExpressionJXB", "title":"upper bound", "description":"The base entity for alteration upper bound expression." }, "fixedAlteration":{ "items":{ "$ref":"#/components/schemas/FixedAlterationPopJXB" }, "type":"array", "title":"(required*) fixed alteration", "description":"Defines the fixed alteration product offering price. This is a required field and has to be one of fixedAlteration or percentAlteration." }, "percentAlteration":{ "items":{ "$ref":"#/components/schemas/PercentAlterationPopJXB" }, "type":"array", "title":"(required*) percent alteration", "description":"Defines percentage Alteration value. This is a required field and has to be one of fixedAlteration or percentAlteration." } }, "type":"object", "title":"alteration price tier range", "description":"The container object that defines the charge tier range." }, "FixedAlterationPopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "alterationAppliesTo", "alterationBasedOn", "priceType", "incrementStep", "prorateLastIncrementStep" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"price", "description":"The amount that is discounted." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"The type of unit to which the charge applies. Possible values are NONE, MINUTES, SECONDS, DAYS, HOURS, BYTES, GBYTES, BMYTES, MBYTES." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"The balance element configuration object's numeric code." }, "alterationAppliesTo":{ "$ref":"#/components/schemas/AlterationRecipientTypeJXB", "title":"alteration applied to", "description":"Specifies which object owner the balance should be applied to. Possible values are payer, user, both." }, "alterationBasedOn":{ "$ref":"#/components/schemas/AlterationBasisExpressionJXB", "title":"alteration based on", "description":"Defines on how much quantity the alteration/discount must be applied. It is defined at the pricing level." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"The type of impact. It can be grant, consumption or aggregation." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"The time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"The tax code used for the discount." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"The tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector ID", "description":"The tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"General Ledger ID", "description":"The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "incrementStep":{ "format":"float", "type":"number", "title":"increment step", "description":"The smallest increment step size on which the scaled impact should be calculated (beat). The default value is 1." }, "prorateLastIncrementStep":{ "type":"boolean", "title":"prorate last increment", "description":"Prorates the last increment step." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which then can be used at rating time to impact different price. All elements are required except description." } }, "type":"object", "title":"fixed alteration pop", "description":"Defines the fixed alteration product offering price." }, "PercentAlterationPopJXB":{ "required":[ "price", "unitOfMeasure", "balanceElementNumCode", "alterationAppliesTo", "alterationBasedOn", "priceType" ], "properties":{ "price":{ "format":"double", "type":"number", "title":"price", "description":"Applies to the amount discounted." }, "unitOfMeasure":{ "$ref":"#/components/schemas/UnitOfMeasureJXB", "title":"unit of measure", "description":"The unit type to which the discount applies. Possible values are NONE, MINUTES, SECONDS, DAYS, HOURS, BYTES, GBYTES, BMYTES, MBYTES." }, "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"The balance element configuration object's numeric code." }, "alterationAppliesTo":{ "$ref":"#/components/schemas/AlterationRecipientTypeJXB", "title":"alteration applies to", "description":"Specifies to which object owner the balance should be applied. Possible values are payer, user, both." }, "alterationBasedOn":{ "$ref":"#/components/schemas/AlterationBasisExpressionJXB", "title":"alteration based on", "description":"Defines the quantity to which the alteration/discount must be applied. It is defined at the pricing level." }, "priceType":{ "$ref":"#/components/schemas/PriceTypeJXB", "title":"price type", "description":"The type of impact. It can ve grant, consumption or aggregation." }, "taxTime":{ "$ref":"#/components/schemas/TaxTimeJXB", "title":"tax time", "description":"The time when the discount is taxed." }, "taxCode":{ "type":"string", "title":"tax code", "description":"The discount's tax code." }, "taxSelectorName":{ "type":"string", "title":"tax selector name", "description":"The tax selector's name." }, "taxSelectorIID":{ "type":"string", "title":"tax selector ID", "description":"The tax selector's ID." }, "glid":{ "format":"int32", "type":"integer", "title":"General Ledger ID", "description":"The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact." }, "priceValidity":{ "$ref":"#/components/schemas/PriceValidityJXB", "title":"price validity", "description":"Defines the validity period for the credited amount in the balance impact." }, "priceTag":{ "items":{ "$ref":"#/components/schemas/PriceTagJXB" }, "type":"array", "title":"price tag", "description":"Tags any pricing attribute at design time which then can be used at rating time to impact different price. All elements are required except description." } }, "type":"object", "title":"percent alteration pop", "description":"Defines the percentage alteration value." }, "AlterationRecipientTypeJXB":{ "enum":[ "BOTH", "PAYER", "USER" ], "type":"string", "description":"Specifies to which object owner the balance should be applied. Possible values are payer, user, both." }, "AlterationBasisExpressionJXB":{ "properties":{ "quantityBasisExpression":{ "$ref":"#/components/schemas/QuantityAlterationBasisExpressionJXB", "title":"(required*) quantity basis expression", "description":"The tier basis expression for RUM Quantity. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." }, "balanceBasisExpression":{ "$ref":"#/components/schemas/BalanceAlterationBasisExpressionJXB", "title":"(required*) balance basis expression", "description":"The tier basis expression for balance. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." }, "chargeBasisExpression":{ "$ref":"#/components/schemas/ChargeAlterationBasisExpressionJXB", "title":"(required*) charge basis expression", "description":"The tier basis expression for charge. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." }, "customBasisExpression":{ "$ref":"#/components/schemas/CustomAlterationBasisExpressionJXB", "title":"(required*) custom basis expression", "description":"The user defined tier basis expression. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." }, "numberBasisExpression":{ "$ref":"#/components/schemas/NumberAlterationBasisExpressionJXB", "title":"(required*) number basis expression", "description":"The number expression for tier basis. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." }, "binaryBasisExpression":{ "$ref":"#/components/schemas/BinaryAlterationBasisExpressionJXB", "title":"(required*) binary basis expression", "description":"The tier basis expression for binary operation. It is a required field and has to be one of quantityBasisExpression, balanceBasisExpression, chargeBasisExpression, customBasisExpression, numberBasisExpression, or binaryBasisExpression." } }, "type":"object", "title":"alteration basis expression", "description":"Specifies the left operand of alteration basis expression." }, "QuantityAlterationBasisExpressionJXB":{ "required":[ "useTierComponent" ], "properties":{ "useTierComponent":{ "type":"boolean", "title":"user tier component", "description":"Indiactes whether to only use tier component." } }, "type":"object", "title":"quantity alteration basis expression", "description":"The tier basis expression for RUM Quantity." }, "BalanceAlterationBasisExpressionJXB":{ "required":[ "balanceElementNumCode" ], "properties":{ "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"Defines the balance element numeric code." }, "memberBalance":{ "type":"boolean", "title":"member balance", "description":"If the discount is associated with the member balance group, then the value is true." } }, "type":"object", "title":"balance alteration basis expression", "description":"The tier basis expression for balance." }, "ChargeAlterationBasisExpressionJXB":{ "properties":{ "useTierComponent":{ "type":"boolean", "title":"user tier component", "description":"Indiactes whether to only use the tier component." }, "preRated":{ "type":"boolean", "title":"pre rated", "description":"Indicates whether the charge is prerated." } }, "type":"object", "title":"charge alteration basis expression", "description":"The tier basis expression for charge." }, "CustomAlterationBasisExpressionJXB":{ "required":[ "functionName" ], "properties":{ "functionName":{ "type":"string", "title":"function name", "description":"The custom method's name." } }, "type":"object", "title":"custom alteration basis expression", "description":"The user defined tier basis expression." }, "NumberAlterationBasisExpressionJXB":{ "required":[ "value" ], "properties":{ "value":{ "format":"double", "type":"number", "title":"value", "description":"The numeric value for the tier basis." } }, "type":"object", "title":"number alteration basis expression", "description":"The number expression for the tier basis." }, "BinaryAlterationBasisExpressionJXB":{ "required":[ "binaryOperator", "leftOperand", "rightOperand" ], "properties":{ "binaryOperator":{ "type":"string", "title":"binary operator", "description":"An arithmatic operator for binary expression." }, "leftOperand":{ "$ref":"#/components/schemas/AlterationBasisExpressionJXB", "title":"left operand", "description":"Specifies the left operand of the alteration basis expression." }, "rightOperand":{ "$ref":"#/components/schemas/AlterationBasisExpressionJXB", "title":"right operand", "description":"Specifies the right operand of the alteration basis expression." } }, "type":"object", "title":"binary alteration basis expression", "description":"The tier basis expression for binary operation." }, "NumberAlterationTBExpressionJXB":{ "required":[ "value" ], "properties":{ "value":{ "type":"string", "title":"value", "description":"The tier bound's numeric value." } }, "type":"object", "title":"number alteration tier bound expression", "description":"The alteration tier bound expression for number." }, "BalanceAlterationTBExpressionJXB":{ "required":[ "balanceElementNumCode" ], "properties":{ "balanceElementNumCode":{ "format":"int64", "type":"integer", "title":"balance element num code", "description":"The balance element configuration object's numeric code." }, "memberBalance":{ "type":"boolean", "title":"member balance", "description":"If the discount is associated with a member balance group, then the value is true." } }, "type":"object", "title":"balance alteration tier bound expression", "description":"The alteration tier bound expression for balance." }, "CustomAlterationTBExpressionJXB":{ "required":[ "functionName" ], "properties":{ "functionName":{ "type":"string", "title":"function name", "description":"The custom method's name." } }, "type":"object", "title":"custom alteration tier bound expression", "description":"The user defined tier bound expression." }, "BinaryAlterationTBExpressionJXB":{ "required":[ "binaryOperator", "leftOperand", "rightOperand" ], "properties":{ "binaryOperator":{ "type":"string", "title":"binary operator", "description":"An arithmatic operator for the binary tier bound expression." }, "leftOperand":{ "$ref":"#/components/schemas/AlterationTierBoundExpressionJXB", "title":"left operand", "description":"Specifies the left operand of the alteration tier bound expression." }, "rightOperand":{ "$ref":"#/components/schemas/AlterationTierBoundExpressionJXB", "title":"right operand", "description":"Specifies the right operand of the alteration bound expression." } }, "type":"object", "title":"binary alteration tier bound expression", "description":"The tier bound expression for binary operation." }, "QuantityAlterationTBExpressionJXB":{ "required":[ "useTierComponent" ], "properties":{ "useTierComponent":{ "type":"boolean", "title":"user tier component", "description":"Indicates whether to only use the tier component." } }, "type":"object", "title":"quantity alteration tier bound expression", "description":"The tier bound expression for RUM quantity." }, "ChargeAlterationTBExpressionJXB":{ "properties":{ "useTierComponent":{ "type":"boolean", "title":"user tier component", "description":"Indicates whether to only use the tier component." }, "preRated":{ "type":"boolean", "title":"pre rated", "description":"Indicates whether the charge is prerated." } }, "type":"object", "title":"charge alteration tier bound expression", "description":"The tier bound expression for charge." }, "ResourcesConsumptionOrderJXB":{ "enum":[ "EARLIEST_EXPIRY", "RULE_ORDER" ], "type":"string" }, "AlterationDateRangeRPEBranchJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "startDate":{ "type":"string" }, "endDate":{ "type":"string" }, "arpDateRange":{ "$ref":"#/components/schemas/AlterationDateRangeRPEBranchJXB" }, "alterationConfiguration":{ "items":{ "$ref":"#/components/schemas/AlterationRPEBranchJXB" }, "type":"array" }, "arpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" }, "alterationPopModelName":{ "type":"string" } }, "type":"object" }, "AlterationRPEBranchJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "applicableChargeAndQuantity":{ "$ref":"#/components/schemas/ApplicableChargeAndQuantityJXB" }, "triggerSpecName":{ "type":"string" }, "chargeSelectorSpecName":{ "items":{ "type":"string" }, "type":"array" }, "arpDateRange":{ "$ref":"#/components/schemas/AlterationDateRangeRPEBranchJXB" }, "alterationConfiguration":{ "items":{ "$ref":"#/components/schemas/AlterationRPEBranchJXB" }, "type":"array" }, "arpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB" }, "alterationPopModelName":{ "type":"string" } }, "type":"object" }, "TODModeJXB":{ "enum":[ "END_TIME", "START_TIME", "TIMED" ], "type":"string", "description":"The Time Of the Day Mode. Indicates if events should be rated using startTime, endTime, or split to use both." }, "ApplicableQuantityTreatmentJXB":{ "enum":[ "CONTINUOUS", "ISOLATED" ], "type":"string", "description":"Indicates if the applicable quantity should be treated continuous or isolated." }, "PermittedTypeJXB":{ "enum":[ "CUSTOMER", "PRODUCT" ], "type":"string", "description":"Specifies whether it is a product or a customer type." }, "BillOffsetUnitJXB":{ "enum":[ "DAYS", "MONTHS" ], "type":"string", "description":"Specifies the offset unit (days or months) to bill in advance." }, "ARatePlanElementJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" } }, "type":"object" }, "ChargeRateSubscriberCurrencyRPEJXB":{ "required":[ "currencyCode" ], "properties":{ "currencyCode":{ "items":{ "type":"string" }, "type":"array", "title":"currency code", "description":"The three letter ISO code for currency." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) charge rate subscriber currency", "description":"The subscription's currency details. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. The most common RUMs are Duration and Volume. Before you create product offerings, you must define the RUMs available for rating. You define RUMs when you create the service-event map. For each event, you specify the RUMs that can be used for rating it. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is used in a charge to apply prices based on the rule results. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A are a set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"It is a special capability that enables the user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"It is a rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"charge rate subscriber currency", "description":"The currency details of the subscription." }, "ApplicableRumRPEBranchJXB":{ "required":[ "applicableRumName" ], "properties":{ "applicableRumName":{ "items":{ "type":"string" }, "type":"array", "title":"applicable rum name", "description":"RUMs are ways in which you can measure events. The most common RUMs are Duration and Volume. Before you create product offerings, you must define the RUMs available for rating. You define RUMs when you create the service-event map. For each event, you specify the RUMs that can be used for rating it." }, "minQuantity":{ "format":"double", "type":"number", "title":"min quantity", "description":"The minimum value that the RUM quantity is rounded to. A value smaller than min_quantity is rounded to min_quantity." }, "minQuantityUnit":{ "$ref":"#/components/schemas/RumQuantityUnitJXB", "title":"min quantity unit", "description":"The unit for the mininimum quantity." }, "incrementQuantity":{ "format":"double", "type":"number", "title":"increment quantity", "description":"The incremental value that the RUM quantity is rounded to. RUM quantity is always rounded to an integral multiple of the increment quantity." }, "incrementQuantityUnit":{ "$ref":"#/components/schemas/RumQuantityUnitJXB", "title":"increment quantity unit", "description":"Specifies the increment quantity." }, "roundingMode":{ "$ref":"#/components/schemas/RoundingModeJXB", "title":"rounding mode", "description":"Specifies how the RUM quantity is rounded." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables the user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp conposite pop model", "description":"A rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"applicable rum rate plan branch", "description":"RUMs are ways in which you can measure events." }, "GenericSelectorRPEJXB":{ "required":[ "genericSelectorName", "results" ], "properties":{ "genericSelectorName":{ "type":"string", "title":"generic selector name", "description":"The generic selector's name." }, "results":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerResultsJXB" }, "type":"array", "title":"attribute analyzer results", "description":"The branch of the generic selectors. It contains the list of results based on the values of specified event attributes, service attributes, or custom rules." } }, "type":"object", "title":"generic selector rate plan element", "description":"A generic selector is a set of rules that map service and event attributes and expressions to a result. You use a generic selector in a charge to apply prices based on the rule results." }, "ChargeRateDateRangeJXB":{ "required":[ "absoluteDateRange" ], "properties":{ "absoluteDateRange":{ "$ref":"#/components/schemas/CRAbsoluteDateRangeJXB", "title":"charge rate date range", "description":"A container for defining the effective date range for a fixed period." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "type":"array" }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB", "title":"(required*) crp date range", "desscription":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "type":"array" }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "type":"array" }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"A rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"charge rate date range", "description":"Describes the date range validity of the charge rate plan." }, "ChargeRateRelDateRangeJXB":{ "properties":{ "absoluteDateRange":{ "$ref":"#/components/schemas/CRAbsoluteDateRangeJXB", "title":"(required*) absolute date range", "description":"Container for defining the effective date range for a fixed period. It is required and has to be either absoluteDateRange or relativeDateRange." }, "relativeDateRange":{ "$ref":"#/components/schemas/RelativeDateRangeJXB", "title":"(required*) relative date range", "description":"A container that definines a relative date range for a product purchase. It is required and has to be either absoluteDateRange or relativeDateRange." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"A rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"charge rate release date range", "description":"Describes the relative date range validity of the charge rate plan." }, "CRAttributeAnalyzerRPEJXB":{ "required":[ "attributeAnalyzerModelName" ], "properties":{ "stereoType":{ "$ref":"#/components/schemas/AAStereoTypeJXB", "title":"stereo type", "description":"Specifies the selector type." }, "attributeAnalyzerModelName":{ "type":"string", "title":"attribute analyzer model name", "description":"The attribute analyzer model's name." } }, "type":"object", "title":"charge rate attribute analyzer rate plan element", "description":"A container object used for modeling expressions based on event, product and customer attributes." }, "ZoneModelRPEJXB":{ "required":[ "zoneModelName", "results" ], "properties":{ "zoneModelName":{ "type":"string", "title":"zone model name", "description":"The zone model's name." }, "results":{ "items":{ "$ref":"#/components/schemas/ZoneResultsJXB" }, "type":"array", "title":"zone results", "description":"Describes the impact category for zones." } }, "type":"object", "title":"zone model RPE", "description":"Zone model rate plan element. Zone models are a set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone." }, "EnhancedZoneRPEJXB":{ "required":[ "zoneModelName", "results" ], "properties":{ "zoneModelName":{ "type":"string", "title":"zone model name", "description":"The zone model's name." }, "uscModelName":{ "type":"string", "title":"usc model name", "description":"The usc model's name." }, "apnModelName":{ "type":"string", "title":"apn model name", "description":"The apn model's name." }, "results":{ "items":{ "$ref":"#/components/schemas/ZoneResultsJXB" }, "type":"array", "title":"zone results", "description":"Dscribes the impact category for zones." } }, "type":"object", "title":"enhanced zone RPE", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge." }, "ChargeRateTimeRPEJXB":{ "required":[ "timeModelName", "tags" ], "properties":{ "timeModelName":{ "type":"string", "title":"time model name", "description":"The time model's name." }, "tags":{ "items":{ "$ref":"#/components/schemas/TimeTagsJXB" }, "type":"array", "title":"time tags", "description":"Specifies the time tags." } }, "type":"object", "title":"charge rate time rate plan element", "description":"Specifies the time model configuration." }, "TimeTagsJXB":{ "required":[ "name" ], "properties":{ "name":{ "items":{ "type":"string" }, "type":"array", "title":"time tag name", "description":"The time tag's name." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. The most common RUMs are Duration and Volume. Before you create product offerings, you must define the RUMs available for rating. You define RUMs when you create the service-event map. For each event, you specify the RUMs that can be used for rating it. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. You use a generic selector in a charge to apply prices based on the rule results. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"It is a generic product offering price model. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"time tags", "description":"Specifies the time tags." }, "ZoneResultsJXB":{ "required":[ "name" ], "properties":{ "name":{ "items":{ "type":"string" }, "type":"array", "title":"zone results name", "description":"Name of the zone results." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"It is generic product offering price model. A rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"zone results", "description":"Describes the impact category for zones. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "AttributeAnalyzerResultsJXB":{ "required":[ "name" ], "properties":{ "name":{ "items":{ "type":"string" }, "type":"array", "title":"name", "description":"The attribute analyzer result's name." }, "subscriberCurrency":{ "items":{ "$ref":"#/components/schemas/ChargeRateSubscriberCurrencyRPEJXB" }, "type":"array", "title":"(required*) subscriber currency", "description":"The currency details of the subscription. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "applicableRum":{ "items":{ "$ref":"#/components/schemas/ApplicableRumRPEBranchJXB" }, "type":"array", "title":"(required*) applicable rum", "description":"RUMs are ways in which you can measure events. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/GenericSelectorRPEJXB" }, "type":"array", "title":"(required*) generic selector", "description":"A set of rules that map service and event attributes and expressions to a result. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateDateRangeJXB" }, "type":"array", "title":"(required*) crp date range", "description":"Describes the date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpRelDateRange":{ "items":{ "$ref":"#/components/schemas/ChargeRateRelDateRangeJXB" }, "type":"array", "title":"(required*) crp release date range", "description":"Describes the relative date range validity of the charge rate plan. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpAttributeAnalyzerModel":{ "items":{ "$ref":"#/components/schemas/CRAttributeAnalyzerRPEJXB" }, "type":"array", "title":"(required*) crp attribute analyzer model", "description":"A container object used for modeling expressions based on event, product and customer attributes. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "zoneModel":{ "items":{ "$ref":"#/components/schemas/ZoneModelRPEJXB" }, "type":"array", "title":"(required*) zone model", "description":"A set of time zones, such as Pacific Time or Eastern Time. It is used to charge different prices based on customer's time zone. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "enhancedZoneModel":{ "items":{ "$ref":"#/components/schemas/EnhancedZoneRPEJXB" }, "type":"array", "title":"(required*) enhanced zone model", "description":"A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "crpCompositePopModel":{ "$ref":"#/components/schemas/CompositePopModelRPEJXB", "title":"(required*) crp composite pop model", "description":"A rateplan element that directly composes an APopModel. It can be one-time, recurring, or usage type. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." }, "timeConfiguration":{ "items":{ "$ref":"#/components/schemas/ChargeRateTimeRPEJXB" }, "type":"array", "title":"(required*) time configuration", "description":"Specifies the time model configuration. It is a required field and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration." } }, "type":"object", "title":"attribute analyzer results", "description":"Branch of the Generic Selectors. Contains the list of result based on the values of specified event attributes, service attributes, or custom rules." }, "CRAbsoluteDateRangeJXB":{ "required":[ "startDate", "endDate" ], "properties":{ "startDate":{ "type":"string", "title":"start date", "description":"The fixed period's start date." }, "endDate":{ "type":"string", "title":"end date", "description":"The fixed period's end date." } }, "type":"object", "title":"CR absolute date range", "description":"A container that defines the effective date range for a fixed period." }, "RelativeDateRangeJXB":{ "required":[ "startOffset", "startUnit", "endOffset", "endUnit", "base" ], "properties":{ "startOffset":{ "type":"integer", "title":"start offset", "description":"Number of days, hours, minutes, or seconds after the purchase time that the charge takes effect." }, "startUnit":{ "$ref":"#/components/schemas/UnitTypeJXB", "title":"start unit", "description":"Days, hours, minutes, or seconds after the purchase time that the charge takes effect." }, "endOffset":{ "type":"integer", "title":"end offset", "description":"Number of days, hours, minutes, or seconds after the start time that the charge is no longer effective." }, "endUnit":{ "$ref":"#/components/schemas/UnitTypeJXB", "title":"end unit", "description":"Days, hours, minutes, or seconds after the start time that the charge is no longer effective." }, "base":{ "$ref":"#/components/schemas/BaseTypeJXB", "title":"base", "description":"Indicates the base type. The valid value is PRODUCT_PURCHASE." } }, "type":"object", "title":"relative date range", "description":"A container that defines a relative date range for a product purchase." }, "RumQuantityUnitJXB":{ "enum":[ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ], "type":"string", "description":"Measures the RUM quantity." }, "UnitTypeJXB":{ "enum":[ "DAYS", "HOURS", "MINUTES", "SECONDS" ], "type":"string", "description":"Measure the time." }, "BaseTypeJXB":{ "enum":[ "PRODUCT_PURCHASE" ], "type":"string", "description":"Indicates the base type." }, "ChargeSelectorEventConditionJXB":{ "properties":{ "eventField":{ "type":"string" }, "eventValue":{ "type":"string" } }, "type":"object" }, "ATriggerExpressionJXB":{ "properties":{ "operator":{ "$ref":"#/components/schemas/TriggerOperatorJXB" }, "value":{ "format":"double", "type":"number" } }, "type":"object" }, "TriggerOperatorJXB":{ "enum":[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQ", "LESS_THAN", "LESS_THAN_EQ", "NOT_EQUAL_TO" ], "type":"string" }, "TimeModelValidityPeriodJXB":{ "properties":{ "validFrom":{ "type":"string" }, "timeModelTag":{ "items":{ "$ref":"#/components/schemas/TimeModelTagJXB" }, "type":"array" } }, "type":"object" }, "TimeModelTagJXB":{ "properties":{ "tagName":{ "type":"string" }, "timeSpecification":{ "items":{ "$ref":"#/components/schemas/TimeSpecJXB" }, "type":"array" } }, "type":"object" }, "TimeSpecJXB":{ "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "timeOfDay":{ "type":"string" }, "daysOfWeek":{ "$ref":"#/components/schemas/DaysOfWeekJXB" }, "monthsOfYear":{ "$ref":"#/components/schemas/MonthsOfYearJXB" }, "daysOfMonth":{ "type":"string" }, "holiday":{ "type":"boolean" } }, "type":"object" }, "DaysOfWeekJXB":{ "properties":{ "day":{ "items":{ "$ref":"#/components/schemas/DayOfWeekEnumJXB" }, "type":"array" } }, "type":"object" }, "MonthsOfYearJXB":{ "properties":{ "month":{ "items":{ "$ref":"#/components/schemas/MonthOfYearEnumJXB" }, "type":"array" } }, "type":"object" }, "MonthOfYearEnumJXB":{ "enum":[ "APR", "AUG", "DEC", "FEB", "JAN", "JUL", "JUN", "MAR", "MAY", "NOV", "OCT", "SEP" ], "type":"string" }, "DayOfWeekEnumJXB":{ "enum":[ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ], "type":"string" }, "PricingObjectsJXB":{ "properties":{ "chargeRatePlan":{ "items":{ "$ref":"#/components/schemas/ChargeRatePlanJXB" }, "type":"array", "description":"The Charge Rate Plan Pricing Object" }, "priceModel":{ "items":{ "$ref":"#/components/schemas/PriceModelJXB" }, "type":"array" }, "timeModel":{ "items":{ "$ref":"#/components/schemas/TimeModelJXB" }, "type":"array" }, "priceModelSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "apnSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "uscSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "taxSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "taxExemptionSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "genericSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "triggerSpec":{ "items":{ "$ref":"#/components/schemas/TriggerSpecJXB" }, "type":"array" }, "chargeSelectorSpec":{ "items":{ "$ref":"#/components/schemas/ChargeSelectorSpecJXB" }, "type":"array" }, "alterationRatePlan":{ "items":{ "$ref":"#/components/schemas/AlterationRatePlanJXB" }, "type":"array" }, "distributionRatePlan":{ "items":{ "$ref":"#/components/schemas/DistributionRatePlanJXB" }, "type":"array" }, "rolloverRatePlan":{ "items":{ "$ref":"#/components/schemas/RolloverRatePlanJXB" }, "type":"array" }, "chargeRateplanSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "alterationRateplanSelector":{ "items":{ "$ref":"#/components/schemas/AttributeAnalyzerModelJXB" }, "type":"array" }, "chargeOffering":{ "items":{ "$ref":"#/components/schemas/ChargeOfferingJXB" }, "type":"array", "description":"The charge offer pricing object." }, "alterationOffering":{ "items":{ "$ref":"#/components/schemas/AlterationOfferingJXB" }, "type":"array" }, "distributionOffering":{ "items":{ "$ref":"#/components/schemas/DistributionOfferingJXB" }, "type":"array" }, "subscriptionTerms":{ "items":{ "$ref":"#/components/schemas/SubscriptionTermsJXB" }, "type":"array" }, "bundledProductOffering":{ "items":{ "$ref":"#/components/schemas/BundledProductOfferingJXB" }, "type":"array" }, "package":{ "items":{ "$ref":"#/components/schemas/PackageJXB" }, "type":"array" }, "alterationOfferingExclusion":{ "items":{ "$ref":"#/components/schemas/AlterationOfferingExclusionJXB" }, "type":"array" }, "packageExclusion":{ "items":{ "$ref":"#/components/schemas/PackageExclusionJXB" }, "type":"array" }, "packageTransition":{ "items":{ "$ref":"#/components/schemas/PackageTransitionJXB" }, "type":"array" }, "bundledProductOfferingTransition":{ "items":{ "$ref":"#/components/schemas/BundledProductOfferingTransitionJXB" }, "type":"array" }, "bundledProductOfferingDependency":{ "items":{ "$ref":"#/components/schemas/BundledProductOfferingDependencyJXB" }, "type":"array" }, "bestPricing":{ "items":{ "$ref":"#/components/schemas/BestPricingJXB" }, "type":"array" }, "packageList":{ "items":{ "$ref":"#/components/schemas/PackageListJXB" }, "type":"array" }, "subscriptionTermsAutoRenew":{ "items":{ "$ref":"#/components/schemas/SubscriptionTermsAutoRenewJXB" }, "type":"array" } }, "type":"object" } } } }