Get Pricing Object
/pdc/pricing
Request
-
includeReferences: string
Whether to include referenced objects in the response payload: true or false.
-
name: string
The name of the pricing object.
-
type: string
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.
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object
-
alterationOffering: array
alterationOffering
-
alterationOfferingExclusion: array
alterationOfferingExclusion
-
alterationRatePlan: array
alterationRatePlan
-
alterationRateplanSelector: array
alterationRateplanSelector
-
apnSelector: array
apnSelector
-
bestPricing: array
bestPricing
-
bundledProductOffering: array
bundledProductOffering
-
bundledProductOfferingDependency: array
bundledProductOfferingDependency
-
bundledProductOfferingTransition: array
bundledProductOfferingTransition
-
chargeOffering: array
chargeOffering
The charge offer pricing object.
-
chargeRatePlan: array
chargeRatePlan
The Charge Rate Plan Pricing Object
-
chargeRateplanSelector: array
chargeRateplanSelector
-
chargeSelectorSpec: array
chargeSelectorSpec
-
distributionOffering: array
distributionOffering
-
distributionRatePlan: array
distributionRatePlan
-
genericSelector: array
genericSelector
-
package: array
package
-
packageExclusion: array
packageExclusion
-
packageList: array
packageList
-
packageTransition: array
packageTransition
-
priceModel: array
priceModel
-
priceModelSelector: array
priceModelSelector
-
rolloverRatePlan: array
rolloverRatePlan
-
subscriptionTerms: array
subscriptionTerms
-
subscriptionTermsAutoRenew: array
subscriptionTermsAutoRenew
-
taxExemptionSelector: array
taxExemptionSelector
-
taxSelector: array
taxSelector
-
timeModel: array
timeModel
-
triggerSpec: array
triggerSpec
-
uscSelector: array
uscSelector
array
-
Array of:
object ChargeOfferingJXB
Refers to the charge offer pricing object.
array
-
Array of:
object ChargeRatePlanJXB
Refers to the charge rate plan pricing object.
object
-
alterationEventMap: array
alterationEventMap
-
applicableChargeAndQuantity: string
Allowed Values:
[ "ORIGINAL_CHARGE", "REMAINING_CHARGE", "UNUSED_CHARGE_QUANTITY" ]
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
description: string
-
externalID: string
-
groupSharingEnabled: boolean
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
offerType: string
Allowed Values:
[ "AGGREGATION", "ITEM", "SUBSCRIPTION", "SYSTEM" ]
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. -
ownMax: number
(double)
-
ownMin: number
(double)
-
policySpecification: string
-
priceListName: string
-
priceTag: array
priceTag
-
pricingProfileName: string
-
priority: integer
-
productSpecCharacteristic: array
productSpecCharacteristic
-
productSpecName: string
-
provisioningTag: string
-
publishSchemas: array
publishSchemas
-
purchaseMax: number
(double)
-
purchaseMin: number
(double)
-
timeRange: string
-
version: number
(double)
object
object
array
-
Array of:
object PriceTagWithDefaultJXB
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.
array
-
Array of:
object ProductSpecCharacteristicJXB
Defines the custom attributes and their valid values for a charge offer.
object
-
alterationRatePlanInfo: object
RatePlanInfoJXB
-
alterationRatePlanName: string
-
alterationRatePlanSelectorInfo: object
RatePlanSelectorInfoJXB
-
alterationRatePlanSelectorName: string
-
eventName: string
-
notValidAtStartNotValidAtEnd: string
Allowed Values:
[ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
-
notValidAtStartValidAtEnd: string
Allowed Values:
[ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
-
ratePlanIID: string
-
ratePlanSelIID: string
-
snowball: boolean
-
validAtStartNotValidAtEnd: string
Allowed Values:
[ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
-
validIfCancelled: boolean
-
validIfInactive: boolean
object
-
attributeName(required): string
Title:
price tag attribute name
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). -
count: integer
(int64)
Title:
price tag count in charge offer
Refers to the count of the price tag associated in rate plans. -
defaultValue: string
Title:
price tag default value
Refers to the default value of the price tag. -
description: string
Title:
price tag description
Describes the price tag configured with the charge offer. -
tagName(required): string
Title:
price tag name
Refers to the name of the price tag configured with the charge offer. -
tagScope(required): string
Allowed Values:
[ "EVENT_PROFILE" ]
Refers to the price tag's scope. The default value is Event Profile.
object
-
name(required): string
Title:
product spec char name
The special characteristic's name. -
value(required): array
product spec char values
Title:
product spec char values
The list of special characteristics added for a given name.
array
product spec char values
object
-
active: boolean
-
alterationOfferingName: string
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
prohibitedAlterationOfferingName: string
-
publishSchemas: array
publishSchemas
-
version: number
(double)
object
object
object
-
alterationConfiguration: array
alterationConfiguration
-
alterationPopModelName: string
-
arpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
arpDateRange: object
AlterationDateRangeRPEBranchJXB
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
resourcesConsumptionOrder: string
Allowed Values:
[ "EARLIEST_EXPIRY", "RULE_ORDER" ]
-
taxCode: string
-
taxSelectorIID: string
-
taxSelectorName: string
-
version: number
(double)
object
-
alterationPopModel: object
AlterationPopModelJXB
Defines the alteration product offering price model.
-
description: string
Title:
description
Describes the composite product offering price model rate plan. -
name(required): string
Title:
name
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. -
oneTimePopModel: object
OneTimePopModelJXB
Defines the balance impacts for a one time event type. For example, Product Purchase Fee, Product Cancel Fee>/b>, and so on.
-
recurringPopModel: object
RecurringPopModelJXB
Defines the balance impacts for a recurring event type. For example, Monthly Cycle Forward fee.
-
replacementPopModel: object
ReplacementPopModelJXB
Defines the replacement producting offer price model.
-
rolloverPopModel: object
RolloverPopModelJXB
Defines the rollover product offering price model.
-
usageChargePopModel: object
UsageChargePopModelJXB
Defines the usage charge product offering price model.
object
-
alterationConfiguration: array
alterationConfiguration
-
alterationPopModelName: string
-
arpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
arpDateRange: object
AlterationDateRangeRPEBranchJXB
-
description: string
-
endDate: string
-
name: string
-
startDate: string
object
object
object
-
alterationConfiguration: array
alterationConfiguration
-
alterationPopModelName: string
-
applicableChargeAndQuantity: string
Allowed Values:
[ "ORIGINAL_CHARGE", "REMAINING_CHARGE", "UNUSED_CHARGE_QUANTITY" ]
-
arpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
arpDateRange: object
AlterationDateRangeRPEBranchJXB
-
chargeSelectorSpecName: array
chargeSelectorSpecName
-
description: string
-
name: string
-
triggerSpecName: string
object
-
priceTier(required): object
alteration price tier
Title:
alteration price tier
The container object that defines the alteration price tier.
object
-
priceTier(required): object
one time price tier
Title:
one time price tier
Defines the one time price tier.
object
-
priceTier(required): object
RecurringPriceTierJXB
Defines the recurring price tier.
object
-
replacementCharge(required): object
ReplacementPopJXB
Defines the replacement product offering price.
object
-
rolloverCharge(required): array
rollover charge
Title:
rollover charge
Defines the rollover product offering price.
object
-
priceTier(required): array
price tier
Title:
price tier
Defines the charge price tier.
object
alteration price tier
-
distributionMethod(required): string
Allowed Values:
[ "FROM_BAL_IMPACT", "NONE" ]
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. -
lowerBound(required): object
alteration tier bound expression
Title:
alteration tier bound expression
The base entity for alteration lower bound expression. -
tierBasis(required): object
alteration tier expression
Title:
alteration tier expression
The container object that defines alteration tier expression. -
tierRange(required): array
tier range
Title:
tier range
The container object that defines the charge tier range.
object
alteration tier bound expression
-
balanceTBExpression: object
balance alteration tier bound expression
Title:
balance alteration tier bound expression
The alteration tier bound expression for balance. -
binaryTBExpression: object
binary alteration tier bound expression
Title:
binary alteration tier bound expression
The tier bound expression for binary operation. -
chargeTBExpression: object
charge alteration tier bound expression
Title:
charge alteration tier bound expression
The tier bound expression for charge. -
customTBExpression: object
custom alteration tier bound expression
Title:
custom alteration tier bound expression
The user defined tier bound expression. -
numberTBExpression: object
number alteration tier bound expression
Title:
number alteration tier bound expression
The alteration tier bound expression for number. -
quantityTBExpression: object
quantity alteration tier bound expression
Title:
quantity alteration tier bound expression
The tier bound expression for RUM quantity.
object
alteration tier expression
-
balanceTierExpression: object
balance alteration basis expression
Title:
balance alteration basis expression
The tier basis expression for balance. -
binaryTierExpression: object
binary alteration basis expression
Title:
binary alteration basis expression
The tier basis expression for binary operation. -
chargeTierExpression: object
charge alteration basis expression
Title:
charge alteration basis expression
The tier basis expression for charge. -
customTierExpression: object
custom alteration basis expression
Title:
custom alteration basis expression
The user defined tier basis expression. -
numberTierExpression: object
number alteration basis expression
Title:
number alteration basis expression
The number expression for the tier basis. -
quantityTierExpression: object
quantity alteration basis expression
Title:
quantity alteration basis expression
The tier basis expression for RUM Quantity.
array
tier range
-
Array of:
object alteration price tier range
Title:
alteration price tier range
The container object that defines the charge tier range.
object
balance alteration tier bound expression
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
The balance element configuration object's numeric code. -
memberBalance: boolean
Title:
member balance
If the discount is associated with a member balance group, then the value is true.
object
binary alteration tier bound expression
-
binaryOperator(required): string
Title:
binary operator
An arithmatic operator for the binary tier bound expression. -
leftOperand(required): object
alteration tier bound expression
Title:
alteration tier bound expression
The base entity for alteration lower bound expression. -
rightOperand(required): object
alteration tier bound expression
Title:
alteration tier bound expression
The base entity for alteration lower bound expression.
object
charge alteration tier bound expression
-
preRated: boolean
Title:
pre rated
Indicates whether the charge is prerated. -
useTierComponent: boolean
Title:
user tier component
Indicates whether to only use the tier component.
object
custom alteration tier bound expression
-
functionName(required): string
Title:
function name
The custom method's name.
object
number alteration tier bound expression
-
value(required): string
Title:
value
The tier bound's numeric value.
object
quantity alteration tier bound expression
-
useTierComponent(required): boolean
Title:
user tier component
Indicates whether to only use the tier component.
object
balance alteration basis expression
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
Defines the balance element numeric code. -
memberBalance: boolean
Title:
member balance
If the discount is associated with the member balance group, then the value is true.
object
binary alteration basis expression
-
binaryOperator(required): string
Title:
binary operator
An arithmatic operator for binary expression. -
leftOperand(required): object
alteration basis expression
Title:
alteration basis expression
Specifies the left operand of alteration basis expression. -
rightOperand(required): object
alteration basis expression
Title:
alteration basis expression
Specifies the left operand of alteration basis expression.
object
charge alteration basis expression
-
preRated: boolean
Title:
pre rated
Indicates whether the charge is prerated. -
useTierComponent: boolean
Title:
user tier component
Indiactes whether to only use the tier component.
object
custom alteration basis expression
-
functionName(required): string
Title:
function name
The custom method's name.
object
number alteration basis expression
-
value(required): number
(double)
Title:
value
The numeric value for the tier basis.
object
quantity alteration basis expression
-
useTierComponent(required): boolean
Title:
user tier component
Indiactes whether to only use tier component.
object
alteration basis expression
-
balanceBasisExpression: object
balance alteration basis expression
Title:
balance alteration basis expression
The tier basis expression for balance. -
binaryBasisExpression: object
binary alteration basis expression
Title:
binary alteration basis expression
The tier basis expression for binary operation. -
chargeBasisExpression: object
charge alteration basis expression
Title:
charge alteration basis expression
The tier basis expression for charge. -
customBasisExpression: object
custom alteration basis expression
Title:
custom alteration basis expression
The user defined tier basis expression. -
numberBasisExpression: object
number alteration basis expression
Title:
number alteration basis expression
The number expression for the tier basis. -
quantityBasisExpression: object
quantity alteration basis expression
Title:
quantity alteration basis expression
The tier basis expression for RUM Quantity.
object
alteration price tier range
-
fixedAlteration: array
(required*) fixed alteration
Title:
(required*) fixed alteration
Defines the fixed alteration product offering price. This is a required field and has to be one of fixedAlteration or percentAlteration. -
percentAlteration: array
(required*) percent alteration
Title:
(required*) percent alteration
Defines percentage Alteration value. This is a required field and has to be one of fixedAlteration or percentAlteration. -
upperBound(required): object
alteration tier bound expression
Title:
alteration tier bound expression
The base entity for alteration lower bound expression.
array
(required*) fixed alteration
-
Array of:
object fixed alteration pop
Title:
fixed alteration pop
Defines the fixed alteration product offering price.
array
(required*) percent alteration
-
Array of:
object percent alteration pop
Title:
percent alteration pop
Defines the percentage alteration value.
object
fixed alteration pop
-
alterationAppliesTo(required): string
Allowed Values:
[ "BOTH", "PAYER", "USER" ]
Specifies to which object owner the balance should be applied. Possible values are payer, user, both. -
alterationBasedOn(required): object
alteration basis expression
Title:
alteration basis expression
Specifies the left operand of alteration basis expression. -
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
The balance element configuration object's numeric code. -
glid: integer
(int32)
Title:
General Ledger ID
The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact. -
incrementStep(required): number
(float)
Title:
increment step
The smallest increment step size on which the scaled impact should be calculated (beat). The default value is 1. -
price(required): number
(double)
Title:
price
The amount that is discounted. -
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
prorateLastIncrementStep(required): boolean
Title:
prorate last increment
Prorates the last increment step. -
taxCode: string
Title:
tax code
The tax code used for the discount. -
taxSelectorIID: string
Title:
tax selector ID
The tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
The tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
-
endValidityMode: string
Allowed Values:
[ "ABSOLUTE", "NEVER", "RELATIVE_TO_PERIOD_START", "RELATIVE_TO_START" ]
Defines the end validity mode for the price. -
relativeEndOffset: integer
Title:
relative end offset
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. -
relativeEndOffsetUnit: string
Allowed Values:
[ "ACCOUNTING_CYCLE", "BEGIN_OF_DAY", "BILLING_CYCLE", "CALENDAR_DAY", "DAY", "EVENT_CYCLE", "HOUR", "MINUTE", "MONTH", "SECOND" ]
Refers to the offset unit to measure the relative price validity cycle. -
relativeStartOffset: integer
Title:
relative start offset
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. -
relativeStartOffsetUnit: string
Allowed Values:
[ "ACCOUNTING_CYCLE", "BEGIN_OF_DAY", "BILLING_CYCLE", "CALENDAR_DAY", "DAY", "EVENT_CYCLE", "HOUR", "MINUTE", "MONTH", "SECOND" ]
Refers to the offset unit to measure the relative price validity cycle. -
splitDetail: object
split detail
Title:
split detail
Defines the split details for the grant between the start and end date. -
startValidityMode: string
Allowed Values:
[ "ABSOLUTE", "FIRST_USAGE", "FOREVER", "IMMEDIATE", "PERIOD_START", "RELATIVE" ]
Defines the start validity mode for the price. -
validityRange: string
Title:
validity range
Defines the validity range. The DateTimeRange should be defined as YYYYMMDDTHHMMSS or YYYYMMDDTHHMMSS.
object
-
attributeName(required): string
Title:
attribute name
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). -
description: string
Title:
description
Describes the price tag configured with the charge offer. -
tagName(required): string
Title:
tag name
Refers to the name of the price tag configured with the charge offer. -
tagScope(required): string
Allowed Values:
[ "EVENT_PROFILE" ]
Refers to the price tag's scope. The default value is Event Profile.
object
split detail
-
unit: integer
Title:
unit
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(required): string
Allowed Values:
[ "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ]
Defines the split measurement unit. -
validityType(required): string
Allowed Values:
[ "BUCKET", "TOTAL" ]
Defines the split validity type. The default value is BUCKET.
object
percent alteration pop
-
alterationAppliesTo(required): string
Allowed Values:
[ "BOTH", "PAYER", "USER" ]
Specifies to which object owner the balance should be applied. Possible values are payer, user, both. -
alterationBasedOn(required): object
alteration basis expression
Title:
alteration basis expression
Specifies the left operand of alteration basis expression. -
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
The balance element configuration object's numeric code. -
glid: integer
(int32)
Title:
General Ledger ID
The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact. -
price(required): number
(double)
Title:
price
Applies to the amount discounted. -
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
taxCode: string
Title:
tax code
The discount's tax code. -
taxSelectorIID: string
Title:
tax selector ID
The tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
The tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
one time price tier
-
creditLimitProrateQuantity: boolean
Title:
credit limit prorate quantity
Indicates whether to set prorate quantity if credit limit value is insufficient_balance. the default is true. -
enforceCreditLimit: string
Allowed Values:
[ "AUTO_RENEW_CANCEL", "DEDUCT_RENTAL", "DEFAULT", "INSUFFICIENT_BALANCE", "LOAN", "NORMAL", "OUTSTANDING_AMOUNT", "RENTAL_FAILURE", "SKIP_CYCLE" ]
Specifies how to enforce credit limits or let customers exceed them. The default value is NORMAL implying to enforce the credit limit. -
lowerBound(required): string
Title:
lower bound
The starting value for the range. The default value is 0. -
rumName(required): string
Title:
rum name
Name of the RUM. -
tierBasis(required): object
ChargeTierExpressionJXB
Refers to the base abstract entity for the tier expression.
-
tierRange(required): array
tier range
Title:
tier range
Defines the one time price tier range.
object
-
balanceTierExpression: object
balance charge tier expression
Title:
balance charge tier expression
Refers to the tier expression for balance for a charge. -
rumTierExpression: object
RumChargeTierExpressionJXB
Refers to the tier expression base object for RUM quantity for charge.
array
tier range
-
Array of:
object one time price tier range
Title:
one time price tier range
The range of the one-time price tier.
object
balance charge tier expression
-
balanceElementNumCode: integer
(int64)
Title:
balance element num code
Defines the numeric code for the balance element.
object
object
one time price tier range
-
oneTimeCharge(required): array
one time charge
Title:
one time charge
The end value for the range. It is only supported for backward compatibility. -
upperBound(required): string
Title:
upper bound
The end value for the range. It is only supported for backward compatibility. The default value is NO_MAX.
array
one time charge
-
Array of:
object one time charge pop
Title:
one time charge pop
Refers to non recurring charges. For example, setup, cancellation fees.
object
one time charge pop
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
The balance element's numeric code. For example, 840 for USD. -
creditLimitMinimumAmount: number
(double)
Title:
credit limit minimum amount
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. -
discountable: boolean
Title:
discountable
Makes a balance impact discountable. The default value is False. -
glid: integer
(int32)
Title:
General Ledger ID.
The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact. -
impactType: string
Allowed Values:
[ "FIXED", "SCALED" ]
Specifies whether the impact is fixed or scaled. -
price(required): number
(double)
Title:
price
The amount to debit or credit. -
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
taxCode: string
Title:
tax code
The tax code used for the discount. -
taxSelectorIID: string
Title:
tax selector ID
The tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
The tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
-
creditLimitProrateQuantity: boolean
Title:
credit limit prorate quantity
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. -
enforceCreditLimit: string
Allowed Values:
[ "AUTO_RENEW_CANCEL", "DEDUCT_RENTAL", "DEFAULT", "INSUFFICIENT_BALANCE", "LOAN", "NORMAL", "OUTSTANDING_AMOUNT", "RENTAL_FAILURE", "SKIP_CYCLE" ]
Specifies how to enforce credit limits or let customers exceed them. The default value is NORMAL implying to enforce the credit limit. -
lowerBound(required): string
Title:
lower bound
The starting value for the range. The default value is NO_MIN. -
rumName(required): string
Title:
rum name
The RUM's name. -
tierBasis(required): object
ChargeTierExpressionJXB
Refers to the base abstract entity for the tier expression.
-
tierRange(required): array
tier range
Title:
tier range
Defines the recurring price tier range.
array
tier range
-
Array of:
object RecurringPriceTierRangeJXB
Defines the recurring price tier range.
object
-
recurringCharge(required): array
recurring charge
Title:
recurring charge
Defines the recurring charge product offering price. -
upperBound(required): string
Title:
upper bound
Refers to the maximum value of the range. It supports expressions.
array
recurring charge
-
Array of:
object RecurringChargePopJXB
Defines the recurring charge product offering price.
object
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
The balance element's numeric code. For example, 840 for USD. -
creditLimitMinimumAmount: number
(double)
Title:
credit limit mininum amount
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. -
discountable: boolean
Title:
discountable
Makes a balance impact discountable. The default value is False. -
glid: integer
(int32)
Title:
general ledger ID
The general ledger's ID. It is used for selecting the required general ledger information for a given balance impact. -
impactType(required): string
Allowed Values:
[ "FIXED", "SCALED" ]
Specifies whether the impact is fixed or scaled. -
price(required): number
(double)
Title:
price
The amount of debit or credit. For example 10 USD/GB/MIN. -
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
proratable(required): boolean
Title:
proratable
A boolean flag that sets proration. The default is true. -
taxCode: string
Title:
tax code
The tax code used for the discount. -
taxSelectorIID: string
Title:
tax selector ID
The tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
The tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
Refers to the balance element's numeric code. For example, 840 for USD. -
glid: integer
(int32)
Title:
General Ledger ID
Refers to the General Ledger's ID. It is used for selecting the required General Ledger Information for a given balance impact. -
price(required): number
(double)
Title:
price
The amount of debit or credit. For example 10 USD/GB/MIN. -
rumName: string
Title:
rum name
The RUM's name. -
taxCode: string
Title:
tax code
Refers to the tax code used for the discount. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
type(required): string
Allowed Values:
[ "ABSOLUTE_VALUE", "PERCENTAGE", "REPLACEMENT_VALUE" ]
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.
array
rollover charge
-
Array of:
object RolloverPopJXB
Defines the rollover product offering price.
object
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
Refers to the balance element's numeric code. For example, 840 for USD. -
glid: integer
(int32)
Title:
glid
Refers to the general ledger's ID. It is used for selecting the required general ledger information for a given balance impact. -
rolloverCount: integer
Title:
rollover count
Specifies the maximum number of periods to rollover. The default value 1. -
rolloverMaxUnits(required): number
(double)
Title:
rollover max units
Specifies the maximum quantity that can be rolled over. -
rolloverUnits(required): number
(double)
Title:
rollover units
Specifies the quantity to rollover per period. -
unitOfMeasure(required): string
Allowed Values:
[ "DAYS", "MONTHS", "WEEKS", "YEARS" ]
Configures the frequency of rollover. For example, monthly, days, years. Possible values are days, months, weeks, years.
array
price tier
-
Array of:
object ChargePriceTierJXB
Defines the charge price tier.
object
-
applicableQuantity(required): string
Allowed Values:
[ "ORIGINAL", "REMAINING" ]
Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer. -
currencyCode: string
Title:
currency code
Refers to the three letter ISO code for the currency. -
distributionMethod(required): string
Allowed Values:
[ "FROM_BAL_IMPACT", "NONE" ]
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. -
enforceCreditLimit: string
Allowed Values:
[ "AUTO_RENEW_CANCEL", "DEDUCT_RENTAL", "DEFAULT", "INSUFFICIENT_BALANCE", "LOAN", "NORMAL", "OUTSTANDING_AMOUNT", "RENTAL_FAILURE", "SKIP_CYCLE" ]
Specifies how to enforce credit limits or let customers exceed them. The default value is NORMAL implying to enforce the credit limit. -
priceTierValidityPeriod(required): array
price tier validity period
Title:
price tier validity period
Defines the charge price tier validity period structure. -
rumName(required): string
Title:
rum name
The RUM's name. -
tierBasis: object
ChargeTierExpressionJXB
Refers to the base abstract entity for the tier expression.
array
price tier validity period
-
Array of:
object PriceTierValidityPeriodJXB
Defines the charge price tier validity period structure.
object
-
lowerBound(required): string
Title:
lower bound
The starting value for the range. The default value is 0. -
minimumCharge: array
minimum charge
Title:
minimum charge
Defines a minimum charge configuration for a balance element. -
priceTag: array
price tag
Title:
price tag
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. -
priceTierRange(required): array
price tier range
Title:
price tier range
Defines the charge price tier range. -
validFrom(required): string
Title:
valid from
Defines the start of the validity period. The format is YYYYMMDDTHHMMSS and the default value is 0/inf.
array
minimum charge
-
Array of:
object MinimumChargeJXB
Defines a minimum charge configuration for a balance element.
array
price tag
-
Array of:
object PriceTagJXB
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.
array
price tier range
-
Array of:
object ChargePriceTierRangeJXB
Defines the charge price tier range.
object
-
balanceElementNumCode: integer
(int64)
Title:
balance element num code
Refers to the balance element's numeric code. For example, 840 for USD. -
value: number
(double)
Title:
value
Defines the minimum charge value for a balance element.
object
-
fixedCharge: array
(required*) fixed charge
Title:
(required*) fixed charge
Defines the fixed charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge. -
priceTag: array
price tag
Title:
price tag
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. -
scaledCharge: array
(required*) scaled charge
Title:
(required*) scaled charge
Defines the scaled charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge. -
upperBound: string
Title:
(required*) upper bound
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: object
ChargeTierBoundExpressionJXB
Defines the end value for a quantity range or the noncurrency balance element to consume.
array
(required*) fixed charge
-
Array of:
object FixedChargePopJXB
Defines the fixed charge product offering price.
array
price tag
-
Array of:
object PriceTagJXB
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.
array
(required*) scaled charge
-
Array of:
object ScaledChargePopJXB
Defines the scaled charge product offering price.
object
-
balanceTBExpression: object
balance charge tier bound expression
Title:
balance charge tier bound expression
Refers to the tier bound expression for balance. -
numberTBExpression: object
number charge tier bound expression
Title:
number charge tier bound expression
Refers to the number expression for the charge tier bound.
object
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
Refers to the balance element's numeric code. For example, 840 for USD. -
discountable: boolean
Title:
discountable
Refers to the boolean flag to make a balance impact discountable. The default value is False. -
glid: integer
(int32)
Title:
general ledger ID
Refers to the General Ledger's ID. It is used for selecting the required General Ledger information for a given balance impact. -
periodConditionExpression: object
period condition expression
Title:
period condition expression
Defines the Period Condition Expression. -
price(required): number
(double)
Title:
Refers to the amount of debit or credit. For example <b>10 USD/GB/MIN</b>.
-
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
taxCode: string
Title:
tax code
Refers to the tax code used for the discount. -
taxSelectorIID: string
Title:
tax selector ID
Refers to the tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
Refers to the the tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
object
period condition expression
-
biConditionOperator: string
Allowed Values:
[ "EQUAL_TO" ]
Defines the balance impact condition operator EQUAL TO. -
periodStartTime(required): string
Allowed Values:
[ "ALIGN_WITH_OFFER_START", "BEGIN_OF_CALENDAR_UNIT", "IMMEDIATE" ]
Defines the Period Start Time. -
unit(required): string
Allowed Values:
[ "DAY", "HOUR" ]
Defines the unit of the Period Condition Expression. -
value(required): integer
Title:
value
Defines the value of the Period Condition Expression.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
-
balanceElementNumCode(required): integer
(int64)
Title:
balance element num code
Refers to the balance element's numeric code. For example, 840 for USD. -
discountable: boolean
Title:
discountable
Refers to the boolean flag to make a balance impact discountable. The default value is False. -
glid: integer
(int32)
Title:
general ledger ID
Refers to the General Ledger's ID. It is used for selecting the required General Ledger information for a given balance impact. -
incrementRounding: string
Allowed Values:
[ "DOWN", "NONE", "UP" ]
Specifies the rounding method for the increment step. The valid values are 0 - None, 1 - Up and 2 -Down. The default value is 0. -
incrementStep: number
(float)
Title:
increment step
Specifies the smallest increment step size on which the scaled impact should be calculated (beat). The default Value is 1. -
price(required): number
(double)
Title:
price
Refers to the amount of debit or credit. For example 10 USD/GB/MIN. -
priceTag: array
price tag
Title:
price tag
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. -
priceType(required): string
Allowed Values:
[ "AGGREGATION", "CONSUMPTION", "GRANT" ]
Refers to the impact type. -
priceValidity: object
PriceValidityJXB
Defines the validity period for the credited amount in the balance impact.
-
taxCode: string
Title:
tax code
Refers to the tax code used for the discount. -
taxSelectorIID: string
Title:
tax selector id
Refers to the tax selector's ID. -
taxSelectorName: string
Title:
tax selector name
Refers to the tax selector's name. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
unitOfMeasure(required): string
Allowed Values:
[ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
Refers to the type of unit to which the pricing applies. For example minute, byte.
array
price tag
-
Array of:
object PriceTagJXB
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.
object
balance charge tier bound expression
-
balanceElementNumCode: integer
(int64)
Title:
balance element num code
Defines the balance element's numeric code.
object
number charge tier bound expression
-
value: string
Title:
value
Refers to the numeric value for the tier bound. It is Float.POSITIVE_INFINITY for Inf and Float.NEGATIVE_INFINITY for -Inf.
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
description: string
-
eventSpecName: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
modelData: array
modelData
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
productSpecName: string
-
publishSchemas: array
publishSchemas
-
stereoType: string
Allowed Values:
[ "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" ]
Specifies the type of selector. -
validityPeriod: array
validityPeriod
-
version: number
(double)
object
object
object
-
complexAAExpression: array
complexAAExpression
-
crSelectorExpression: array
crSelectorExpression
-
customExpression: array
customExpression
-
fieldToFieldExpression: array
fieldToFieldExpression
-
fieldToValueExpression: array
fieldToValueExpression
-
name: string
-
namedResultExpression: array
namedResultExpression
-
result: array
result
-
ruleData: array
ruleData
-
valueMapExpression: array
valueMapExpression
object
-
leftOperand: object
AttributeAnalyzerExpressionsJXB
-
operator: string
Allowed Values:
[ "AND", "NONE", "NOT", "OR" ]
-
rightOperand: object
AttributeAnalyzerExpressionsJXB
object
-
complexAAExpression: object
ComplexAAExpressionJXB
-
crSelectorExpression: object
CRSelectorExpressionJXB
-
customExpression: object
CustomExpressionJXB
-
fieldToFieldExpression: object
FieldToFieldExpressionJXB
-
fieldToValueExpression: object
FieldToValueExpressionJXB
-
namedResultExpression: object
NamedResultExpressionJXB
-
valueMapExpression: object
ValueMapExpressionJXB
object
-
leftOperand: string
-
operator: string
Allowed Values:
[ "AND", "NONE", "NOT", "OR" ]
-
rightOperand: string
object
-
lhsFieldKind: string
Allowed Values:
[ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
-
lhsFieldName: string
-
operation: string
Allowed Values:
[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "MAPS_TO", "NOT_EQUAL_TO", "REGEX" ]
-
rhsFieldKind: string
Allowed Values:
[ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
-
rhsFieldName: string
-
seperator: string
object
-
fieldKind: string
Allowed Values:
[ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
-
fieldName: string
-
fieldValue: string
-
operation: string
Allowed Values:
[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "MAPS_TO", "NOT_EQUAL_TO", "REGEX" ]
-
seperator: string
object
-
fieldKind: string
Allowed Values:
[ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
-
fieldName: string
-
mappedValue: string
-
operation: string
Allowed Values:
[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "MAPS_TO", "NOT_EQUAL_TO", "REGEX" ]
-
seperator: string
-
valueMapName: string
-
zoneModelName: string
object
-
alternateBundledProductOffering: array
alternateBundledProductOffering
-
bundledProductOfferingName: string
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
mode: string
Allowed Values:
[ "FULL_RERATE", "ONE_TIME_ADJUST" ]
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
version: number
(double)
object
object
object
-
amount: number
(double)
-
balanceElementNumCode: integer
(int64)
-
operator: string
Allowed Values:
[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "LESS_THAN", "LESS_THAN_EQUAL", "NOT_EQUAL_TO" ]
object
-
billOnPurchase: boolean
-
bundledProductOfferingItem: array
bundledProductOfferingItem
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
customize: string
Allowed Values:
[ "OPTIONAL", "PROHIBITED", "REQUIRED" ]
-
description: string
-
externalID: string
-
firstUsageActivation: boolean
-
groupBalanceElements: boolean
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
productSpecCharacteristic: array
productSpecCharacteristic
-
productSpecName: string
-
publishSchemas: array
publishSchemas
-
subscriptionTermsIID: string
-
subscriptionTermsName: string
-
timeRange: string
-
version: number
(double)
object
object
array
-
Array of:
object ProductSpecCharacteristicJXB
Defines the custom attributes and their valid values for a charge offer.
object
-
addOnOfferingValidityMode: string
Allowed Values:
[ "BASE_OFFER", "BASE_OFFER_EXPIRY_FIRST", "BASE_OFFER_EXPIRY_LAST", "BASE_OR_ADD_ON_OFFER_EXPIRY_FIRST", "BASE_OR_ADD_ON_OFFER_EXPIRY_LAST" ]
-
alterationOfferingName: string
-
baseChargeOfferingName: string
-
chargeOfferingName: string
-
cycleChargeAdjustment: number
(double)
-
cycleEnd: object
ValidityJXB
-
cycleStart: object
ValidityJXB
-
gracePeriodOffset: integer
-
gracePeriodUnit: string
Allowed Values:
[ "DAY", "HOUR", "MINUTE", "SECOND" ]
-
prorationBasedOn: string
Allowed Values:
[ "PRORATE_30_DAYS", "PRORATE_DAYS_IN_MONTH" ]
-
purchaseChargeAdjustment: number
(double)
-
purchaseEnd: object
ValidityJXB
-
purchaseMode: string
Allowed Values:
[ "EXTEND", "EXTEND_NEW_SUB_BAL", "LONGEST_DATE", "LONGEST_DATE_NEW_SUB_BAL", "NEW_INSTANCE", "OVERWRITE" ]
-
purchaseStart: object
ValidityJXB
-
quantity: number
(double)
-
renewalMode: boolean
-
status: integer
-
statusCode: integer
-
usageChargeAdjustment: number
(double)
-
usageEnd: object
ValidityJXB
-
usageStart: object
ValidityJXB
object
-
mode: string
Allowed Values:
[ "FIRST_USAGE", "NOW_TO_NEVER", "RELATIVE" ]
-
offset: integer
-
unit: string
Allowed Values:
[ "CYCLE", "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ]
object
-
active: boolean
-
bundledProductOfferingName: string
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
prerequisiteBundledProductOfferingName: string
-
priceListName: string
-
pricingProfileName: string
-
prohibitedBundledProductOfferingName: string
-
publishSchemas: array
publishSchemas
-
version: number
(double)
object
object
object
-
active: boolean
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
description: string
-
externalID: string
-
fromBundledProductOfferingName: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
productSpecName: string
-
prorationType: string
Allowed Values:
[ "ORIGINAL_CHARGE", "PRORATE_CHARGE", "TRANSFER_CHARGE" ]
-
publishSchemas: array
publishSchemas
-
timeRange: string
-
toBundledProductOfferingName: string
-
type: string
Allowed Values:
[ "DOWNGRADE", "UPGRADE" ]
-
version: number
(double)
-
waiveCancelFee: boolean
-
waivePurchaseFee: boolean
object
object
object
-
applicableQuantity(required): string
Allowed Values:
[ "ORIGINAL", "REMAINING" ]
Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer. -
changeSetName: string
Title:
change set name
Refers to the name of the change set of the charge offer. -
chargeEventMap(required): array
chargeEventMap
-
createdDate: object
created date
Title:
created date
Refers to the date and time the object was created. -
createdUser: string
Title:
created user
Refers to the user that created the object. -
currentStateName: string
Title:
current state name
Refers to the name of current state of the charge offer. -
customerSpecName: string
Title:
(required*) customer specification name
Refers to the tag used for Account as a service. One of the fields customerSpecName and productSpecName are required and they are mutually exclusive. -
dateRangeImpactType: string
Allowed Values:
[ "EVENT_DATE", "INSTANTIATED_DATE", "PURCHASE_DATE" ]
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. -
deliverable: array
deliverable
-
description: string
Title:
description
Describes the charge offer. -
expiryNotification: boolean
Title:
expiry notification
Triggers notifications to be sent to the customer when the charge offer is about to expire. The default value is true>/b>. -
externalID: string
Title:
External id of charge offer.
Refers to the object's external ID. It is used to create cross references, in case of migration. -
groupSharingEnabled: boolean
Title:
group sharing enable/disable
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. -
internalId: string
Title:
internal id
Refers to the Unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration was committed. -
lastModifiedDate: object
last modified date
Title:
last modified date
Refers to the date and time the object was modified. -
lastModifiedUser: string
Title:
last modified user
Refers to the user that modified the object. -
name(required): string
Title:
name
The charge offer's name. -
newName: string
Title:
new name
Refers to the new name given to the already named charge offer. -
obsolete: boolean
Title:
obsolete
Obsoletes the promoted or active objects. -
offerType: string
Allowed Values:
[ "AGGREGATION", "ITEM", "SUBSCRIPTION", "SYSTEM" ]
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. -
ownMax: number
(double)
Title:
maximum no of charge offer can be owned
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. -
ownMin: number
(double)
Title:
minimum no of charge offer can be owned
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. -
partial: boolean
Title:
partial
Enables partial purchases. -
policySpecification: string
Title:
policy specification
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. -
priceListName: string
Title:
price list name
The name of the price list. By default, this is configured as Default. Keep the value as Default. -
priceTag: array
priceTag
-
pricingProfileName(required): string
Title:
pricing profile name
Determines which features are supported for the charge based on the charge category and charge type. -
priority: integer
Title:
priority
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. -
productSpecCharacteristic: array
productSpecCharacteristic
Defines custom attributes and their valid values for a charge offer.
-
productSpecName: string
Title:
(required*) product specification name
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. -
provisioningTag: string
Title:
provisioning tag
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. -
purchaseCycleDOM: integer
(int32)
Title:
purchase cycle day of month
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. -
purchaseMax: number
(double)
Title:
purchase maximum
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. -
purchaseMin: number
(double)
Title:
purchase minimum
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. -
retryMaxCount: integer
(int32)
Title:
maximum number of retry in total
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. -
retryOffset: integer
(int32)
Title:
subsequent retry frequency
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. -
retryUnit: string
Allowed Values:
[ "DAY", "HOUR", "MINUTE", "MONTH", "SECOND", "WEEK", "YEAR" ]
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. -
scaleRounding: string
Allowed Values:
[ "OFF", "ON" ]
Specifies whether to calculate the scale based on validityRounding. -
subscriptionDueNotification: boolean
Title:
subscription due notification
Triggers notifications to be sent to the customer before the subscription is due for renewal. The default value is true. -
taxExemptionSelectorIID: string
Title:
tax exemption selector id
Refers to the tax exemption selector's ID. -
taxExemptionSelectorName: string
Title:
tax exemption selector name
The name of the tax exemption selector. -
taxSupplier: string
Title:
tax supplier
Refers to the tax supplier's name for the charge offer. -
timeRange(required): string
Title:
time range
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. -
validityRounding: string
Allowed Values:
[ "NOT_SET", "OFF", "ON" ]
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. -
version: number
(double)
Title:
charge offer version
Refers to the Pricing Design Center version of the object.
object
created date
array
-
Array of:
object ChargeOfferDeliverableJXB
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.
object
last modified date
array
-
Array of:
object PriceTagWithDefaultJXB
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.
array
-
Array of:
object ProductSpecCharacteristicJXB
Defines the custom attributes and their valid values for a charge offer.
object
-
chargeRatePlanInfo: object
ChargeRatePlanInfoJXB
Indicates to which rating engine(s) the charge rate plan is published.
-
chargeRatePlanName: string
Title:
(required*) charge rate plan name
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. -
chargeRatePlanSelectorName: string
Title:
(required*) charge rate plan selector name
Refers to the charge selector's name. One of the fields chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive.. -
description: string
Title:
charge event description
Describes the charge event map configured. -
eventName(required): string
Title:
charge event name
Refers to the event's name. -
incrementQuantity(required): number
Title:
rum round increment quantity
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(required): string
Title:
rum round increment quantity unit
Refers to the units that increment quantity is specified in. Possible values are. -
minQuantity(required): number
Title:
rum min round quantity
Refers to the minimum value that the RUM quantity is rounded to. The minimum quantity starts from 0 by default. -
minQuantityUnit(required): string
Title:
rum min quantity unit
Refers to the unit in which the minimum quantity is expressed. Possible values are none, second, minute, hour, day. -
prorateCycle: string
Allowed Values:
[ "FULL_CHARGE", "NOT_APPLICABLE", "NO_CHARGE", "PRORATE_CHARGE" ]
Specifies how to apply cycle fee or rollover when a customer makes changes to subscription in the middle of the billing cycle. -
prorateFirst(required): string
Allowed Values:
[ "FULL_CHARGE", "NOT_APPLICABLE", "NO_CHARGE", "PRORATE_CHARGE" ]
Specifies how to apply cycle fee or rollover when a customer makes changes to subscription in the middle of the billing cycle. -
prorateLast(required): string
Allowed Values:
[ "FULL_CHARGE", "NOT_APPLICABLE", "NO_CHARGE", "PRORATE_CHARGE" ]
Specifies how to apply cycle fee or rollover when a customer makes changes to subscription in the middle of the billing cycle. -
ratePlanIID: string
Title:
rate plan id
The charge rate plan's ID generated internally by the PDC system for the charge event map. -
ratePlanSelIID: string
Title:
rate plan selector id
The charge selector's ID generated internally by the PDC system for the charge event map. -
rolloverRatePlanName: string
Title:
(required*) rollover rate plan name
Refers to the rollover rate plan's name. One of the fiels chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive. -
roundingMode(required): string
Allowed Values:
[ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]
Specifies how a RUM quantity is rounded. -
rum: string
Title:
rum name
The name of the RUM. RUMs specify the units used to measure an event and how to calculate the measurement. -
timezoneMode(required): string
Allowed Values:
[ "ACCOUNT", "EVENT", "SERVER" ]
Determines the time zone used to rate an event. -
validIfCancelled(required): boolean
Title:
charge valid if canceled
Specifies to charge even if the instantiated product offering status is canceled. The default value is true. -
validIfInactive(required): boolean
Title:
charge valid if inactive
Specifies to charge even if the instantiated product offering status is inactive. The default value is true. -
validIfSuspendedActive: boolean
Title:
charge valid if suspended active
Specifies to charge even if the instantiated product offering status is suspended but active. The default value is true.
object
-
targetEngine: array
charge rate plan target engine
Title:
charge rate plan target engine
Refers to the target engine where the information about the charge offer is to be published.
array
charge rate plan target engine
object
-
deliverableIID: string
Title:
deliverable id
The deliverable's internal ID. -
deliverableName(required): string
Title:
deliverable name
The deliverable's name.
object
-
applicableQtyTreatment: string
Allowed Values:
[ "CONTINUOUS", "ISOLATED" ]
Indicates if the applicable quantity should be treated continuous or isolated. -
applicableQuantity: string
Allowed Values:
[ "ORIGINAL", "REMAINING" ]
Specifies how a charge offer is applied on a chargable quantity. This can be REMAINING or ORIGINAL based on the type of charge offer. -
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
applicableRums(required): array
applicable rums
Title:
applicable rums
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. -
billOffset: integer
Title:
bill offset
Specifies the offset (number of days or months) to bill in advance. -
changeSetName: string
Title:
change set name
The name of the change set of the charge rate plan. -
createdDate: object
creation date
Title:
creation date
Refers to the date and time the object was created. -
createdUser: string
Title:
creator
Refers to the user that created the object. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp relative date range
Title:
(required*) crp relative date range
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. -
currentStateName: string
Title:
current state name
The name of the current state of the charge rate plan. -
cycleFeeFlag: integer
Title:
cycle fee flag
Specifies how to align recurring charges. '0' for billing date, '1' puchase date. -
description: string
Title:
description
Describes the charge rate plan. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
eventName(required): string
Title:
event name
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). -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
internalId: string
Title:
internal id
The unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration is commited. -
lastModifiedDate: object
modification date
Title:
modification date
Refers to the date and time the object was modified. -
lastModifiedUser: string
Title:
modifier
Refers to the user that modified the object. -
name(required): string
Title:
name
The name of the charge rate plan. -
newName: string
Title:
new name
The new name given to the already named charge rate plan. -
obsolete: boolean
Title:
obsolete
Obsoletes the promoted or active objects. -
offsetUnit: string
Allowed Values:
[ "DAYS", "MONTHS" ]
Specifies the offset unit (days or months) to bill in advance. -
permittedName: string
Title:
permitted name
Refers to the service to which the charge applies. -
permittedType: string
Allowed Values:
[ "CUSTOMER", "PRODUCT" ]
Specifies whether it is a product or a customer type. -
priceListName: string
Title:
price list name
Name of the price list. By default, this is configured as Default. Keep the value as Default. -
pricingProfileName(required): string
Title:
pricing profile name
Name of the pricing profile. It determines the features supported for the charge based on the charge category and charge type. -
ratePlanElement: object
ARatePlanElementJXB
-
subscriberCurrency(required): array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
taxCode: string
Title:
tax code
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. -
taxSelectorIID: string
Title:
tax selector id
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. -
taxSelectorName: string
Title:
tax selector name
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. -
taxTime: string
Allowed Values:
[ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
Refers to the time when the charge is taxed. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
todMode: string
Allowed Values:
[ "END_TIME", "START_TIME", "TIMED" ]
The Time Of the Day Mode. Indicates if events should be rated using startTime, endTime, or split to use both. -
version: number
(double)
Title:
pdc version
Refers to the Pricing Design Center version of the object. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
applicable rums
object
creation date
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp relative date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
object
modification date
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
applicable rum rate plan branch
-
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
applicableRumName(required): array
applicable rum name
Title:
applicable rum name
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
incrementQuantity: number
(double)
Title:
increment quantity
The incremental value that the RUM quantity is rounded to. RUM quantity is always rounded to an integral multiple of the increment quantity. -
incrementQuantityUnit: string
Allowed Values:
[ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]
Measures the RUM quantity. -
minQuantity: number
(double)
Title:
min quantity
The minimum value that the RUM quantity is rounded to. A value smaller than min_quantity is rounded to min_quantity. -
minQuantityUnit: string
Allowed Values:
[ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]
Measures the RUM quantity. -
roundingMode: string
Allowed Values:
[ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]
Specifies how a RUM quantity is rounded. -
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
applicable rum name
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
charge rate attribute analyzer rate plan element
-
attributeAnalyzerModelName(required): string
Title:
attribute analyzer model name
The attribute analyzer model's name. -
stereoType: string
Allowed Values:
[ "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" ]
Specifies the type of selector.
object
charge rate date range
-
absoluteDateRange(required): object
CR absolute date range
Title:
CR absolute date range
A container that defines the effective date range for a fixed period. -
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
crpDateRange
-
crpRelDateRange: array
crpRelDateRange
-
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
genericSelector
-
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
object
CR absolute date range
-
endDate(required): string
Title:
end date
The fixed period's end date. -
startDate(required): string
Title:
start date
The fixed period's start date.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
charge rate release date range
-
absoluteDateRange: object
CR absolute date range
Title:
CR absolute date range
A container that defines the effective date range for a fixed period. -
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
relativeDateRange: object
relative date range
Title:
relative date range
A container that defines a relative date range for a product purchase. -
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
object
relative date range
-
base(required): string
Allowed Values:
[ "PRODUCT_PURCHASE" ]
Indicates the base type. -
endOffset(required): integer
Title:
end offset
Number of days, hours, minutes, or seconds after the start time that the charge is no longer effective. -
endUnit(required): string
Allowed Values:
[ "DAYS", "HOURS", "MINUTES", "SECONDS" ]
Measure the time. -
startOffset(required): integer
Title:
start offset
Number of days, hours, minutes, or seconds after the purchase time that the charge takes effect. -
startUnit(required): string
Allowed Values:
[ "DAYS", "HOURS", "MINUTES", "SECONDS" ]
Measure the time.
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
enhanced zone RPE
-
apnModelName: string
Title:
apn model name
The apn model's name. -
results(required): array
zone results
Title:
zone results
Dscribes the impact category for zones. -
uscModelName: string
Title:
usc model name
The usc model's name. -
zoneModelName(required): string
Title:
zone model name
The zone model's name.
array
zone results
-
Array of:
object zone results
Title:
zone results
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.
object
zone results
-
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
name(required): array
zone results name
Title:
zone results name
Name of the zone results. -
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
zone results name
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
generic selector rate plan element
-
genericSelectorName(required): string
Title:
generic selector name
The generic selector's name. -
results(required): array
attribute analyzer results
Title:
attribute analyzer results
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.
array
attribute analyzer results
-
Array of:
object attribute analyzer results
Title:
attribute analyzer results
Branch of the Generic Selectors. Contains the list of result based on the values of specified event attributes, service attributes, or custom rules.
object
attribute analyzer results
-
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
name(required): array
name
Title:
name
The attribute analyzer result's name. -
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
charge rate subscriber currency
-
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
currencyCode(required): array
currency code
Title:
currency code
The three letter ISO code for currency. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
subscriberCurrency: array
(required*) charge rate subscriber currency
Title:
(required*) charge rate subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
currency code
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
(required*) charge rate subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
charge rate time rate plan element
-
tags(required): array
time tags
Title:
time tags
Specifies the time tags. -
timeModelName(required): string
Title:
time model name
The time model's name.
object
time tags
-
applicableRum: array
(required*) applicable rum
Title:
(required*) applicable rum
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. -
crpAttributeAnalyzerModel: array
(required*) crp attribute analyzer model
Title:
(required*) crp attribute analyzer model
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. -
crpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
crpDateRange: array
(required*) crp date range
Title:
(required*) crp date range
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: array
(required*) crp release date range
Title:
(required*) crp release date range
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. -
enhancedZoneModel: array
(required*) enhanced zone model
Title:
(required*) enhanced zone model
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. -
genericSelector: array
(required*) generic selector
Title:
(required*) generic selector
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. -
name(required): array
time tag name
Title:
time tag name
The time tag's name. -
subscriberCurrency: array
(required*) subscriber currency
Title:
(required*) subscriber currency
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. -
timeConfiguration: array
(required*) time configuration
Title:
(required*) time configuration
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. -
zoneModel: array
(required*) zone model
Title:
(required*) zone model
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.
array
(required*) applicable rum
-
Array of:
object applicable rum rate plan branch
Title:
applicable rum rate plan branch
RUMs are ways in which you can measure events.
array
(required*) crp attribute analyzer model
-
Array of:
object charge rate attribute analyzer rate plan element
Title:
charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
array
(required*) crp date range
-
Array of:
object charge rate date range
Title:
charge rate date range
Describes the date range validity of the charge rate plan.
array
(required*) crp release date range
-
Array of:
object charge rate release date range
Title:
charge rate release date range
Describes the relative date range validity of the charge rate plan.
array
(required*) enhanced zone model
-
Array of:
object enhanced zone RPE
Title:
enhanced zone RPE
A special capability that enables user to use zone models, USC selectors, and Access Point Name (APN) selectors when configuring a charge.
array
(required*) generic selector
-
Array of:
object generic selector rate plan element
Title:
generic selector rate plan element
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.
array
(required*) subscriber currency
-
Array of:
object charge rate subscriber currency
Title:
charge rate subscriber currency
The currency details of the subscription.
array
(required*) time configuration
-
Array of:
object charge rate time rate plan element
Title:
charge rate time rate plan element
Specifies the time model configuration.
array
(required*) zone model
-
Array of:
object zone model RPE
Title:
zone model RPE
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.
object
zone model RPE
-
results(required): array
zone results
Title:
zone results
Describes the impact category for zones. -
zoneModelName(required): string
Title:
zone model name
The zone model's name.
array
zone results
-
Array of:
object zone results
Title:
zone results
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.
object
-
balanceElementNumCode: array
balanceElementNumCode
-
changeSetName: string
-
chargeRatePlanName: array
chargeRatePlanName
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
eventConditions: array
eventConditions
-
externalID: string
-
genericSelectorResult: string
-
glid: array
glid
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
priceModelName: array
priceModelName
-
pricingName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
rumName: array
rumName
-
timeModelName: array
timeModelName
-
timeModelTagName: string
-
validFrom: string
-
validTo: string
-
version: number
(double)
-
zoneModelName: array
zoneModelName
-
zoneResult: string
object
object
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
description: string
-
distributionEventMap: array
distributionEventMap
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
offerType: string
Allowed Values:
[ "AGGREGATION", "ITEM", "SUBSCRIPTION", "SYSTEM" ]
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. -
priceListName: string
-
pricingProfileName: string
-
productSpecCharacteristic: array
productSpecCharacteristic
-
productSpecName: string
-
publishSchemas: array
publishSchemas
-
timeRange: string
-
version: number
(double)
object
object
array
-
Array of:
object ProductSpecCharacteristicJXB
Defines the custom attributes and their valid values for a charge offer.
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
distributionConfiguration: array
distributionConfiguration
-
distributionPopModelName: string
-
drpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
drpDateRange: array
drpDateRange
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
taxCode: string
-
taxSelectorIID: string
-
taxSelectorName: string
-
version: number
(double)
object
object
object
-
chargeSelectorSpecName: array
chargeSelectorSpecName
-
description: string
-
distributionConfiguration: array
distributionConfiguration
-
distributionPopModelName: string
-
drpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
drpDateRange: array
drpDateRange
-
name: string
-
triggerSpecName: string
object
-
description: string
-
distributionConfiguration: array
distributionConfiguration
-
distributionPopModelName: string
-
drpCompositePopModel: object
CompositePopModelRPEJXB
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
-
drpDateRange: array
drpDateRange
-
endDate: string
-
name: string
-
startDate: string
object
-
balanceSpecification: array
balanceSpecification
-
billOnPurchase: boolean
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecPackageItem: object
CustomerSpecPackageItemJXB
-
description: string
-
externalID: string
-
firstUsageActivation: boolean
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
productSpecCharacteristic: array
productSpecCharacteristic
-
productSpecPackageItem: array
productSpecPackageItem
-
publishSchemas: array
publishSchemas
-
subscriptionTermsIID: string
-
subscriptionTermsName: string
-
version: number
(double)
object
object
array
-
Array of:
object ProductSpecCharacteristicJXB
Defines the custom attributes and their valid values for a charge offer.
object
-
balanceCreditProfile: object
BalanceCreditProfileJXB
-
balanceElementNumCode: integer
(int64)
-
consumptionRule: string
Allowed Values:
[ "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" ]
object
-
threshold: number
(double)
-
type: string
Allowed Values:
[ "ABSOLUTE", "ABSOLUTE_LOAN", "PERCENTAGE", "PERCENTAGE_LOAN" ]
object
-
active: boolean
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
packageName: string
-
priceListName: string
-
pricingProfileName: string
-
prohibitedAlterationOfferingName: string
-
publishSchemas: array
publishSchemas
-
version: number
(double)
object
object
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
packageListStatus: string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
-
packageName: array
packageName
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
segment: string
-
type: string
-
version: number
(double)
object
object
object
-
active: boolean
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
customerSpecName: string
-
description: string
-
externalID: string
-
fromPackageName: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
productSpecName: string
-
prorationType: string
Allowed Values:
[ "ORIGINAL_CHARGE", "PRORATE_CHARGE", "TRANSFER_CHARGE" ]
-
publishSchemas: array
publishSchemas
-
timeRange: string
-
toPackageName: string
-
type: string
Allowed Values:
[ "DOWNGRADE", "GENERATION_CHANGE", "UPGRADE" ]
-
version: number
(double)
-
waiveCancelFee: boolean
-
waivePurchaseFee: boolean
object
object
object
-
alterationPopModel: object
AlterationPopModelJXB
Defines the alteration product offering price model.
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
oneTimePopModel: object
OneTimePopModelJXB
Defines the balance impacts for a one time event type. For example, Product Purchase Fee, Product Cancel Fee>/b>, and so on.
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
recurringPopModel: object
RecurringPopModelJXB
Defines the balance impacts for a recurring event type. For example, Monthly Cycle Forward fee.
-
replacementPopModel: object
ReplacementPopModelJXB
Defines the replacement producting offer price model.
-
rolloverPopModel: object
RolloverPopModelJXB
Defines the rollover product offering price model.
-
usageChargePopModel: object
UsageChargePopModelJXB
Defines the usage charge product offering price model.
-
version: number
(double)
object
object
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
dateRange: object
RolloverRateDateRangeJXB
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
taxCode: string
-
taxSelectorIID: string
-
taxSelectorName: string
-
version: number
(double)
object
object
-
description: string
-
endDate: string
-
name: string
-
rolloverPopModel: object
RolloverPopModelJXB
Defines the rollover product offering price model.
-
startDate: string
object
object
-
autoRenew: boolean
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
earlyTerminationOption: string
Allowed Values:
[ "ALLOWED_NO_PENALTY", "ALLOWED_WITH_PENALTY", "NOT_ALLOWED" ]
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
penaltyAmount: number
(double)
-
penaltyBalanceElementNumCode: integer
(int64)
-
penaltyOptions: string
Allowed Values:
[ "CONTRACT_BALANCE", "FULL_CHARGE", "USED_CONTRACT_UNITS" ]
-
penaltyRevenueGlid: integer
(int32)
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
terminationGraceLength: integer
-
terminationGraceUnit: string
Allowed Values:
[ "DAY", "MONTH", "WEEK", "YEAR" ]
-
termLength: integer
-
termUnit: string
Allowed Values:
[ "DAY", "MONTH", "WEEK", "YEAR" ]
-
version: number
(double)
object
object
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
fromSubscriptionTermsIID: string
-
fromSubscriptionTermsName: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
toSubscriptionTermsIID: string
-
toSubscriptionTermsName: string
-
version: number
(double)
object
object
object
-
changeSetName: string
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
holidayCalendarName: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
validityPeriod: array
validityPeriod
-
version: number
(double)
object
object
array
-
Array of:
string
Allowed Values:
[ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ]
array
-
Array of:
string
Allowed Values:
[ "APR", "AUG", "DEC", "FEB", "JAN", "JUL", "JUN", "MAR", "MAY", "NOV", "OCT", "SEP" ]
object
-
changeSetName: string
-
chargeTriggerExpressionOrQuantityTriggerExpressionOrBalanceTriggerExpression: array
chargeTriggerExpressionOrQuantityTriggerExpressionOrBalanceTriggerExpression
-
createdDate: object
createdDate
-
createdUser: string
-
currentStateName: string
-
description: string
-
externalID: string
-
internalId: string
-
lastModifiedDate: object
lastModifiedDate
-
lastModifiedUser: string
-
name: string
-
newName: string
-
obsolete: boolean
-
priceListName: string
-
pricingProfileName: string
-
publishSchemas: array
publishSchemas
-
version: number
(double)
array
object
object
object
-
operator: string
Allowed Values:
[ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQ", "LESS_THAN", "LESS_THAN_EQ", "NOT_EQUAL_TO" ]
-
value: number
(double)
400 Response
500 Response
Examples
Example 1: Get a Specific Pricing Object
This example shows how to retrieve a charge offer without its referenced objects by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
curl -X GET "http://hostname:port/pdc/pricing?name=sample_CO_apr17&type=CHARGE_OFFERING&includeReferences=false)
Example of Response Body
If successful, the response code 200 is returned with a response body. The following sample shows the contents of the response body in JSON format.
{ "chargeOffering": [ { "name": "sample_CO_apr17", "description": "Sample CO created on March 29", "internalId": "41c3f130-5fde-4c4e-a6b0-4a26d20eea44", "externalID": "41c3f130-5fde-4c4e-a6b0-4a26d20eea44", "pricingProfileName": "Product Offering", "priceListName": "Default", "timeRange": "0/inf", "productSpecName": "TelcoGsmTelephony", "offerType": "SUBSCRIPTION", "priority": 0, "purchaseMin": -1.0, "purchaseMax": -1.0, "ownMin": -1.0, "ownMax": -1.0, "applicableQuantity": "REMAINING", "purchaseCycleDOM": 0, "dateRangeImpactType": "EVENT_DATE", "validityRounding": "NOT_SET", "chargeEventMap": [ { "eventName": "EventBillingProductFeeCycleCycle_forward_monthly", "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": "demo_crp_apr17", "ratePlanIID": "e253dc50-3229-4149-9fe4-513a7716bb95" } ] } ] }
Example 2: Get All Pricing Data
This example shows how to retrieve all pricing data in the system by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
curl -X GET "http://hostname:port/pdc/pricing
Example of Response Body
If successful, the response code 200 is returned with a response body. The following sample shows the contents of the response body in JSON format.
{
"priceModel": [
{
"name": "samplePrice_mar9",
"internalId": "56db3762-cf93-40ce-9d69-036459cbf72e",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"usageChargePopModel": {
"priceTier": [
{
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"rumTierExpression": {}
},
"enforceCreditLimit": "DEFAULT",
"rumName": "Duration",
"currencyCode": "BEF",
"priceTierValidityPeriod": [
{
"lowerBound": "0",
"validFrom": "0",
"priceTierRange": [
{
"upperBoundExpression": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"scaledCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 56,
"priceType": "CONSUMPTION",
"incrementStep": 1.0,
"incrementRounding": "NONE"
}
]
}
]
}
],
"applicableQuantity": "ORIGINAL"
}
]
}
}
],
"timeModel": [
{
"name": "sampleTimeModel_mar9",
"description": "sampleTimeModel",
"internalId": "93c3f33d-21da-497f-9b95-ccdf5703af01",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"validityPeriod": [
{
"validFrom": "0",
"timeModelTag": [
{
"tagName": "feb10",
"timeSpecification": [
{
"name": "feb10",
"timeOfDay": "T000000/T000000"
}
]
}
]
}
]
}
],
"taxExemptionSelector": [
{
"name": "sampleTES",
"description": "Editing tax exemption selector",
"internalId": "9c418738-bdfd-4732-a1ae-0ea571c3d52b",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"stereoType": "TAX_EXEMPTION_SELECTOR",
"productSpecName": "TelcoGsmTelephony",
"eventSpecName": "EventBillingProductFeeCycleCycle_forward_monthly",
"customerSpecName": "Account",
"validityPeriod": [
{
"validFrom": "0",
"rule": [
{
"result": [
{
"resultName": "toll"
}
],
"fieldToValueExpression": [
{
"operation": "EQUAL_TO",
"seperator": ";",
"fieldName": "EventBillingProductFeeCycleCycle_forward_monthly.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
}
]
}
]
}
],
"modelData": [
{
"key": "FIELD_COUNT",
"value": "1"
},
{
"key": "field_0.name",
"value": "EventBillingProductFeeCycleCycle_forward_monthly.END_T"
},
{
"key": "field_0.kind",
"value": "EVENT_SPEC_FIELD"
},
{
"key": "field_0.valueType",
"value": "SINGLE_VALUE"
},
{
"key": "field_0.defaultValue",
"value": "*"
},
{
"key": "field_0.operator",
"value": "EQUAL_TO"
}
]
}
],
"genericSelector": [
{
"name": "sampleGS_mar9",
"description": "Editing generic selector",
"internalId": "cbd9b51c-ad18-4a73-8b79-3d36eba8cd88",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"stereoType": "GENERIC_SELECTOR",
"productSpecName": "TelcoGsmTelephony",
"eventSpecName": "EventDelayedSessionTelcoGsm",
"validityPeriod": [
{
"validFrom": "0",
"rule": [
{
"name": "rule_gs",
"result": [
{
"resultName": "*"
}
],
"fieldToValueExpression": [
{
"operation": "EQUAL_TO",
"seperator": ";",
"fieldName": "EventDelayedSessionTelcoGsm.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
},
{
"operation": "EQUAL_TO",
"seperator": ";",
"fieldName": "EventDelayedSessionTelcoGsm.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
}
]
}
]
}
],
"modelData": [
{
"key": "FIELD_COUNT",
"value": "1"
},
{
"key": "field_0.name",
"value": "EventDelayedSessionTelcoGsm.END_T"
},
{
"key": "field_0.kind",
"value": "EVENT_SPEC_FIELD"
},
{
"key": "field_0.valueType",
"value": "SINGLE_VALUE"
},
{
"key": "field_0.defaultValue",
"value": "*"
},
{
"key": "field_0.operator",
"value": "EQUAL_TO"
}
]
}
],
"chargeRatePlan": [
{
"name": "sample_CRP_mar9",
"internalId": "204c6424-215a-47af-a6a3-5e4e333c7f7e",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"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": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_mar10",
"internalId": "d19731c1-b54c-4b9c-b9df-71cdfed9e7b0",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"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": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "charge320",
"internalId": "f16c4bae-c056-432a-ba3c-313c09999794",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"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": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_mar11",
"internalId": "98f66b36-2ced-4a3b-b3ec-e6ff329cbc61",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"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": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_feb20",
"description": "March 9 edit",
"internalId": "765c08fa-d823-4823-8625-24b66477e8cd",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"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": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
}
],
"alterationRatePlan": [
{
"name": "discounForDS",
"internalId": "a5737806-cdef-4efb-beb3-a6e1e3907527",
"pricingProfileName": "Standard Discount",
"priceListName": "Default",
"resourcesConsumptionOrder": "RULE_ORDER",
"arpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"alterationConfiguration": [
{
"applicableChargeAndQuantity": "REMAINING_CHARGE",
"arpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_Dis_mar9",
"description": "Edit discount",
"internalId": "f2b7c346-e9a9-4099-bf6d-21ffe9ade295",
"pricingProfileName": "Subscription Discount",
"priceListName": "Default",
"resourcesConsumptionOrder": "RULE_ORDER",
"arpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"alterationConfiguration": [
{
"applicableChargeAndQuantity": "REMAINING_CHARGE",
"arpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": -0.1,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
}
],
"distributionRatePlan": [
{
"name": "chgShare_mar9",
"internalId": "be32d8d4-0365-4005-bae9-5eebea328fb7",
"pricingProfileName": "Subscription ChargeSharing",
"priceListName": "Default",
"drpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"distributionConfiguration": [
{
"drpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "chgShare",
"description": "Edited Distributed rate plan",
"internalId": "86148b63-4b14-4a47-ab80-7bdd4509c6a7",
"pricingProfileName": "Subscription ChargeSharing",
"priceListName": "Default",
"drpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"distributionConfiguration": [
{
"drpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
}
],
"chargeOffering": [
{
"name": "balaCO",
"internalId": "371d1d81-f63e-4c3c-b042-b164100435f5",
"externalID": "371d1d81-f63e-4c3c-b042-b164100435f5",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"offerType": "SUBSCRIPTION",
"priority": 0,
"purchaseMin": -1.0,
"purchaseMax": -1.0,
"ownMin": -1.0,
"ownMax": -1.0,
"applicableQuantity": "REMAINING",
"purchaseCycleDOM": 0,
"dateRangeImpactType": "EVENT_DATE",
"validityRounding": "NOT_SET",
"chargeEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"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": "charge320",
"ratePlanIID": "f16c4bae-c056-432a-ba3c-313c09999794"
}
]
}
],
"distributionOffering": [
{
"name": "sampleCSO_mar9",
"internalId": "6d349dd4-e35b-4439-886f-7da8df5d90a3",
"externalID": "6d349dd4-e35b-4439-886f-7da8df5d90a3",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"distributionEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"distributionRatePlanInfo": {
"targetEngine": [
"BRE"
]
},
"distributionRatePlanName": "chgShare_mar9",
"ratePlanIID": "be32d8d4-0365-4005-bae9-5eebea328fb7"
}
]
},
{
"name": "sampleCSO",
"description": "Edited Distributed offer",
"internalId": "8ffc431d-035b-4aff-aa4e-7e3addcbb938",
"externalID": "8ffc431d-035b-4aff-aa4e-7e3addcbb938",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"distributionEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"distributionRatePlanInfo": {
"targetEngine": [
"BRE"
]
},
"distributionRatePlanName": "chgShare",
"ratePlanIID": "86148b63-4b14-4a47-ab80-7bdd4509c6a7"
}
]
}
],
"subscriptionTerms": [
{
"name": "samplesubscription_term_mar9",
"description": "Edited time model",
"internalId": "03b33fe0-48be-40d8-a4b8-58b480ae322f",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"termLength": 1,
"termUnit": "MONTH",
"earlyTerminationOption": "ALLOWED_NO_PENALTY",
"terminationGraceLength": 0,
"terminationGraceUnit": "DAY",
"penaltyAmount": 0.0,
"penaltyBalanceElementNumCode": 0,
"penaltyRevenueGlid": 0
}
]
}