1. REST API Reference for Pricing Design Center
  2. Tasks
  3. PDC Pricing Management

Create Pricing Object

post

/pdc/pricing

Creates a new pricing object using the criteria provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : alterationOffering
Type: array
The Alteration/Discount offer pricing object.
Show Source
Nested Schema : alterationOfferingExclusion
Type: array
Discount offer exclusions to prevent a discount offer from being used or purchased when another discount offer or package is owned.
Show Source
Nested Schema : alterationRatePlan
Type: array
The alteration rate plan pricing object.
Show Source
Nested Schema : alterationRateplanSelector
Type: array
The alteration rate plan selector.
Show Source
Nested Schema : apnSelector
Type: array
The APN selector.
Show Source
Nested Schema : bestPricing
Type: array
The best pricing.
Show Source
Nested Schema : bundledProductOffering
Type: array
Bundles group together charge offers and discount offers belonging to the same service.
Show Source
Nested Schema : bundledProductOfferingDependency
Type: array
Defines dependent relationships between bundles.
Show Source
Nested Schema : bundledProductOfferingTransition
Type: array
Defines rules for transitioning from one bundle to another.
Show Source
Nested Schema : chargeOffering
Type: array
The charge offer pricing object.
Show Source
Nested Schema : chargeRatePlan
Type: array
The charge rate plan pricing object.
Show Source
Nested Schema : chargeRateplanSelector
Type: array
The charge rate plan selector.
Show Source
Nested Schema : chargeSelectorSpec
Type: array
Refers to the charge selector specification.
Show Source
Nested Schema : distributionOffering
Type: array
The distribution offer pricing object.
Show Source
Nested Schema : distributionRatePlan
Type: array
The distribution rate plan pricing object.
Show Source
Nested Schema : genericSelector
Type: array
The generic selector.
Show Source
Nested Schema : package
Type: array
A package consists of one or more bundles that is made available to customers for purchase.
Show Source
Nested Schema : packageExclusion
Type: array
Specify the discount offers that cannot be used with the package.
Show Source
Nested Schema : packageList
Type: array
A package list is used to group related packages that can be made available to customer.
Show Source
Nested Schema : packageTransition
Type: array
A package consists of one or more bundles that is made available to customers for purchase. Transition rules are used to upgrade or downgrade a package to another package.
Show Source
  • PackageTransitionJXB
    A package includes one or more bundles available for customers to purchase. Use transition rules to upgrade or downgrade a package to another package.
Nested Schema : priceModel
Type: array
The price model.
Show Source
Nested Schema : priceModelSelector
Type: array
The price model selector.
Show Source
Nested Schema : rolloverRatePlan
Type: array
The rollover rate plan pricing object.
Show Source
Nested Schema : subscriptionTerms
Type: array
The terms of subscription.
Show Source
Nested Schema : subscriptionTermsAutoRenew
Type: array
The terms to automatically renew subscriptions.
Show Source
Nested Schema : taxExemptionSelector
Type: array
The tax exemption selector.
Show Source
Nested Schema : taxSelector
Type: array
The tax selector.
Show Source
Nested Schema : timeModel
Type: array
The time model.
Show Source
Nested Schema : triggerSpec
Type: array
Refers to the trigger specification.
Show Source
Nested Schema : uscSelector
Type: array
The USC selector.
Show Source
Nested Schema : AlterationOfferingJXB
Type: object
This is the alteration or discount offer???s pricing object.
Show Source
Nested Schema : alteration event map
Type: array
Title: alteration event map
Shows the event details related to the discount offer. You can map multiple events within a discount offer, but to enable overrides, map only a single event type per discount offer. Each discount offer maps one-to-one to the alterationEventMap.
Show Source
  • AlterationEventMapJXB
    Illustrates the event details associated with the Discount Offer (DO). You can map multiple events within a DO; however, to enable override capability, each DO must map to only one type of event. There is a one-to-one mapping between the DO and the alterationEventMap.
Nested Schema : created date
Type: object
Title: created date
The date and time the object was created.
Nested Schema : last modified date
Type: object
Title: last modified date
The date and time the object was modified.
Nested Schema : price tag
Type: array
Title: price tag
Tags applicable pricing attributes at design time, enabling them to be used at rating time to impact different price.
Show Source
Nested Schema : product spec characteristic
Type: array
Title: product spec characteristic
Defines Custom Attributes and their valid values for alteration offer.
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : AlterationEventMapJXB
Type: object
Illustrates the event details associated with the Discount Offer (DO). You can map multiple events within a DO; however, to enable override capability, each DO must map to only one type of event. There is a one-to-one mapping between the DO and the alterationEventMap.
Show Source
  • RatePlanInfoJXB
    Indicates to which rating engine(s) the AlterationRatePlan is published to.
  • (required) The name of the discount configuration within the Discount Offer (DO) at a granular, detailed level. The discount configuration name can be any value, such as OneTimeDiscount, RecurringDiscount, or RatingTimeDiscount. This field must be either alterationRatePlanName or alterationRatePlanSelectorName. Required.
  • RatePlanSelectorInfoJXB
    Indicates the rating engine(s) where the alterationRatePlanSelector is published.
  • (required) The name of the alteration rate plan selector. This field must be either alterationRatePlanName or alterationRatePlanSelectorName. Required.
  • Title: event name
    Name of the event. The event type to which the Alteration Offer applies. 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).
  • Allowed Values: [ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
    Specifies how to apply discounts when they are valid from the start of a cycle but end in mid-cycle.
  • Allowed Values: [ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
    Specifies how to apply discounts when they are valid from the start of a cycle but end in mid-cycle.
  • Title: rate plan IID
    Discount rate plan IID generated internally by PDC for the alterationEventMap. It is optional and mutually exlusive to rate plan selector IID.
  • Title: rate plan sel IID
    Specifies the discount rate plan selector IID that PDC generates internally for the alterationEventMap. This field is optional and mutually exclusive with ratePlanIID.
  • Title: snowball
    Displays if this discount is a snowball discount. Specifies whether to enable or disable the feature. Possible values are true (enable) and false (disable). In BRM, a snowball discount is a type of shared billing-time discount that distributes the discount to all accounts in a discount sharing group.
  • Allowed Values: [ "FULL_DISCOUNT", "NOT_APPLICABLE", "NO_DISCOUNT", "PRORATE_DISCOUNT" ]
    Specifies how to apply discounts when they are valid from the start of a cycle but end in mid-cycle.
  • Title: valid if cancelled
    Discount even if the instantiated Alteration Offer status is canceled. BRM offering statuses are, 1 = active, 2 = inactive, 3 = canceled.
  • Title: valid if inactive
    Discount even if the instantiated Alteration Offer status is inactive.
Nested Schema : RatePlanInfoJXB
Type: object
Indicates to which rating engine(s) the AlterationRatePlan is published to.
Show Source
  • taget engine
    Title: taget engine
    Specifies the target engine where the system publishes information about the Discount Offer. Possible values are BRE, ECE, and RRE.
Nested Schema : RatePlanSelectorInfoJXB
Type: object
Indicates the rating engine(s) where the alterationRatePlanSelector is published.
Show Source
  • target engine
    Title: target engine
    Specifies the target engine where the system publishes information about the alterationRatePlanSelector. Possible values are BRE, ECE, and RRE.
Nested Schema : taget engine
Type: array
Title: taget engine
Specifies the target engine where the system publishes information about the Discount Offer. Possible values are BRE, ECE, and RRE.
Show Source
Nested Schema : target engine
Type: array
Title: target engine
Specifies the target engine where the system publishes information about the alterationRatePlanSelector. Possible values are BRE, ECE, and RRE.
Show Source
Nested Schema : PriceTagWithDefaultJXB
Type: object
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.
Show Source
  • 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).
  • Title: price tag count in charge offer
    Refers to the count of the price tag associated in rate plans.
  • Title: price tag default value
    Refers to the default value of the price tag.
  • Title: price tag description
    Describes the price tag configured with the charge offer.
  • Title: price tag name
    Refers to the name of the price tag configured with the charge offer.
  • Allowed Values: [ "EVENT_PROFILE" ]
    Refers to the price tag's scope. The default value is Event Profile.
Nested Schema : ProductSpecCharacteristicJXB
Type: object
Key-value pair for defining special characteristics in a product.
Show Source
Nested Schema : product spec char values
Type: array
Title: product spec char values
List of special characteristics added for a given name.
Show Source
Nested Schema : AlterationOfferingExclusionJXB
Type: object
Configure discount offer exclusions to block a discount offer from being used or purchased when another discount offer or package is owned.
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date and time the object was modified last.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : AlterationRatePlanJXB
Type: object
Refers to the alteration rate plan pricing object.
Show Source
Nested Schema : alterationConfiguration
Type: array
(required) The alteration???s configuration, including triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec and define conditions with charge selector specs. You can specify arpDateRange, alterationConfiguration, or arpCompositePopModel. This is a required field.
Show Source
  • AlterationRPEBranchJXB
    This field defines the alteration configuration and is associated with triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications.
Nested Schema : CompositePopModelRPEJXB
Type: object
Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
Show Source
Nested Schema : arpDateRange
Type: array
(required) The date-range validity of the alteration rate plan. You can specify arpDateRange, alterationConfiguration, or arpCompositePopModel. This is a required field.
Show Source
Nested Schema : created date
Type: object
Title: created date
The date and time the object was created.
Nested Schema : last modified date
Type: object
Title: last modified date
The date and time the object was modified.
Nested Schema : AlterationRPEBranchJXB
Type: object
This field defines the alteration configuration and is associated with triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications.
Show Source
  • alterationConfiguration
    (required) This field defines the alteration configuration, including triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
  • Allowed Values: [ "ORIGINAL_CHARGE", "REMAINING_CHARGE", "UNUSED_CHARGE_QUANTITY" ]
    Determines how the discounts are applied to the charge when a charge is eligible for multiple discount offers. This option is not valid for discount offers that credit a balance.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • arpDateRange
    (required) This field describes the date range validity of the alteration rate plan. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
  • charge selector spec name
    Title: charge selector spec name
    This field specifies one or more names of the charge selector specifications that the AlterationRatePlanElement uses to identify charges eligible for discounting. The specifications are reusable, and the are evaluated with an implicit OR. Possible values are any existing charge selector specification name in your system (for example, ChargeSelector_OnNet, ChargeSelector_International). This field is required.
  • Title: trigger spec name
    This field specifies the name of the trigger specification (TriggerSpec). A TriggerSpec contains one or more Trigger Expressions that the system evaluates with an implicit AND, and these expressions can target Charge, Quantity, Balance, or Custom conditions. Possible values are any existing TriggerSpec name in your system (for example, Trigger_OnPurchase, Trigger_HighUsage). This field is required.
Nested Schema : alterationConfiguration
Type: array
(required) This field defines the alteration configuration, including triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
Show Source
  • AlterationRPEBranchJXB
    This field defines the alteration configuration and is associated with triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications.
Nested Schema : arpDateRange
Type: array
(required) This field describes the date range validity of the alteration rate plan. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
Show Source
Nested Schema : charge selector spec name
Type: array
Title: charge selector spec name
This field specifies one or more names of the charge selector specifications that the AlterationRatePlanElement uses to identify charges eligible for discounting. The specifications are reusable, and the are evaluated with an implicit OR. Possible values are any existing charge selector specification name in your system (for example, ChargeSelector_OnNet, ChargeSelector_International). This field is required.
Show Source
Nested Schema : AlterationDateRangeRPEBranchJXB
Type: object
Describes the date range validity of the alteration rate plan.
Show Source
Nested Schema : alterationConfiguration
Type: array
(required) The alteration configuration and is associated with triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with charge selector specifications. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
Show Source
  • AlterationRPEBranchJXB
    This field defines the alteration configuration and is associated with triggers and selectors for Charge, Quantity, or Balance. Configure triggers with TriggerSpec, and define conditions with a set of charge selector specifications.
Nested Schema : arpDateRange
Type: array
(required) The date range validity of the alteration rate plan. Possible values are arpDateRange, alterationConfiguration, arpCompositePopModel. This field is required.
Show Source
Nested Schema : AlterationPopModelJXB
Type: object
Defines the alteration product offering price model.
Show Source
Nested Schema : onetime pop model
Type: object
Title: onetime pop model
Defines the balance impacts for a one time event type. For example, Product Purchase Fee, Product Cancel Fee>/b>, and so on.
Show Source
Nested Schema : RecurringPopModelJXB
Type: object
Defines the balance impacts for a recurring event type. For example, Monthly Cycle Forward fee.
Show Source
Nested Schema : ReplacementPopModelJXB
Type: object
Defines the replacement producting offer price model.
Show Source
Nested Schema : RolloverPopModelJXB
Type: object
Defines the rollover product offering price model.
Show Source
Nested Schema : UsageChargePopModelJXB
Type: object
Defines the usage charge product offering price model.
Show Source
Nested Schema : alteration price tier
Type: object
Title: alteration price tier
The container object that defines the alteration price tier.
Show Source
Nested Schema : alteration tier bound expression
Type: object
Title: alteration tier bound expression
The base entity for alteration lower bound Expression.
Show Source
Nested Schema : alteration tier expression
Type: object
Title: alteration tier expression
The container object that defines alteration tier expression.
Show Source
Nested Schema : tier range
Type: array
Title: tier range
The container object that defines the charge tier range.
Show Source
Nested Schema : balance alteration tier bound expression
Type: object
Title: balance alteration tier bound expression
The alteration tier bound expression for Balance.
Show Source
Nested Schema : binary alteration tier bound expression
Type: object
Title: binary alteration tier bound expression
The tier bound expression for Binary operation.
Show Source
Nested Schema : charge alteration tier bound expression
Type: object
Title: charge alteration tier bound expression
The tier bound expression for Charge.
Show Source
Nested Schema : custom alteration tier bound expression
Type: object
Title: custom alteration tier bound expression
The user defined tier bound expression.
Show Source
Nested Schema : number alteration tier bound expression
Type: object
Title: number alteration tier bound expression
The alteration tier bound expression for Number.
Show Source
Nested Schema : quantity alteration tier bound expression
Type: object
Title: quantity alteration tier bound expression
The tier bound expression for RUM Quantity.
Show Source
Nested Schema : balance alteration basis expression
Type: object
Title: balance alteration basis expression
The tier basis expression for Balance.
Show Source
Nested Schema : binary alteration basis expression
Type: object
Title: binary alteration basis expression
The tier basis expression for binary operation.
Show Source
Nested Schema : charge alteration basis expression
Type: object
Title: charge alteration basis expression
The tier basis expression for Charge.
Show Source
Nested Schema : custom alteration basis expression
Type: object
Title: custom alteration basis expression
The user defined tier basis expression.
Show Source
Nested Schema : number alteration basis expression
Type: object
Title: number alteration basis expression
The number expression for the tier basis.
Show Source
Nested Schema : quantity alteration basis expression
Type: object
Title: quantity alteration basis expression
The tier basis expression for RUM Quantity.
Show Source
Nested Schema : alteration basis expression
Type: object
Title: alteration basis expression
Specifies the left operand of alteration basis expression.
Show Source
Nested Schema : alteration price tier range
Type: object
Title: alteration price tier range
The container object that defines the charge tier range.
Show Source
Nested Schema : fixedAlteration
Type: array
(required) The fixed alteration product offering price. This is a required field and has to be one of fixedAlteration or percentAlteration.
Show Source
Nested Schema : percentAlteration
Type: array
(required) The percentage alteration value. This is a required field and has to be one of fixedAlteration or percentAlteration.
Show Source
Nested Schema : fixed alteration pop
Type: object
Title: fixed alteration pop
Defines the fixed alteration product offering price.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : PriceValidityJXB
Type: object
Defines the validity period for the credited amount in the balance impact.
Show Source
  • Allowed Values: [ "ABSOLUTE", "NEVER", "RELATIVE_TO_PERIOD_START", "RELATIVE_TO_START" ]
    Defines the end validity mode for the price.
  • 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.
  • 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.
  • 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.
  • 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.
  • split detail
    Title: split detail
    Defines the split details for the grant between the start and end date.
  • Allowed Values: [ "ABSOLUTE", "FIRST_USAGE", "FOREVER", "IMMEDIATE", "PERIOD_START", "RELATIVE" ]
    Defines the start validity mode for the price.
  • Title: validity range
    Defines the validity range. The DateTimeRange should be defined as YYYYMMDDTHHMMSS or YYYYMMDDTHHMMSS.
Nested Schema : PriceTagJXB
Type: object
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.
Show Source
  • 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).
  • Title: description
    Describes the price tag configured with the charge offer.
  • Title: tag name
    Refers to the name of the price tag configured with the charge offer.
  • Allowed Values: [ "EVENT_PROFILE" ]
    Refers to the price tag's scope. The default value is Event Profile.
Nested Schema : split detail
Type: object
Title: split detail
Defines the split details for the grant between the start and end date.
Show Source
  • 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.
  • Allowed Values: [ "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ]
    Defines the split measurement unit.
  • Allowed Values: [ "BUCKET", "TOTAL" ]
    Defines the split validity type. The default value is BUCKET.
Nested Schema : percent alteration pop
Type: object
Title: percent alteration pop
Defines the percentage alteration value.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : one time price tier
Type: object
Title: one time price tier
Defines the one time price tier.
Show Source
Nested Schema : ChargeTierExpressionJXB
Type: object
Refers to the base abstract entity for the tier expression.
Show Source
Nested Schema : tier range
Type: array
Title: tier range
Defines the one time price tier range.
Show Source
Nested Schema : balance charge tier expression
Type: object
Title: balance charge tier expression
Refers to the tier expression for balance for a charge.
Show Source
Nested Schema : RumChargeTierExpressionJXB
Type: object
Refers to the tier expression base object for RUM quantity for charge.
Nested Schema : one time price tier range
Type: object
Title: one time price tier range
The range of the one-time price tier.
Show Source
Nested Schema : one time charge
Type: array
Title: one time charge
The end value for the range. It is only supported for backward compatibility.
Show Source
Nested Schema : one time charge pop
Type: object
Title: one time charge pop
Refers to non recurring charges. For example, setup, cancellation fees.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : RecurringPriceTierJXB
Type: object
Defines the recurring price tier.
Show Source
Nested Schema : tier range
Type: array
Title: tier range
Defines the recurring price tier range.
Show Source
Nested Schema : RecurringPriceTierRangeJXB
Type: object
Defines the recurring price tier range.
Show Source
Nested Schema : recurring charge
Type: array
Title: recurring charge
Defines the recurring charge product offering price.
Show Source
Nested Schema : RecurringChargePopJXB
Type: object
Defines the recurring charge product offering price.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : ReplacementPopJXB
Type: object
Defines the replacement product offering price.
Show Source
  • Title: balance element num code
    Refers to the balance element's numeric code. For example, 840 for USD.
  • 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.
  • Title: price
    The amount of debit or credit. For example 10 USD/GB/MIN.
  • Title: rum name
    The RUM's name.
  • Title: tax code
    Refers to the tax code used for the discount.
  • Allowed Values: [ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
    Refers to the time when the charge is taxed.
  • 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.
Nested Schema : rollover charge
Type: array
Title: rollover charge
Defines the rollover product offering price.
Show Source
Nested Schema : RolloverPopJXB
Type: object
Defines the rollover product offering price.
Show Source
Nested Schema : price tier
Type: array
Title: price tier
Defines the charge price tier.
Show Source
Nested Schema : ChargePriceTierJXB
Type: object
Defines the charge price tier.
Show Source
Nested Schema : price tier validity period
Type: array
Title: price tier validity period
Defines the charge price tier validity period structure.
Show Source
Nested Schema : PriceTierValidityPeriodJXB
Type: object
Defines the charge price tier validity period structure.
Show Source
Nested Schema : minimum charge
Type: array
Title: minimum charge
Defines a minimum charge configuration for a balance element.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : price tier range
Type: array
Title: price tier range
Defines the charge price tier range.
Show Source
Nested Schema : minimum charge
Type: object
Title: minimum charge
Defines a minimum charge configuration for a balance element.
Show Source
Nested Schema : ChargePriceTierRangeJXB
Type: object
Defines the charge price tier range.
Show Source
Nested Schema : fixedCharge
Type: array
(required) The fixed charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : scaledCharge
Type: array
(required) The scaled charge product offering price. It is a required field and has to be either fixedCharge or scaledCharge.
Show Source
Nested Schema : ChargeTierBoundExpressionJXB
Type: object
Defines the end value for a quantity range or the noncurrency balance element to consume.
Show Source
Nested Schema : FixedChargePopJXB
Type: object
Defines the fixed charge product offering price.
Show Source
Nested Schema : period condition expression
Type: object
Title: period condition expression
Defines the Period Condition Expression.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : ScaledChargePopJXB
Type: object
Defines the scaled charge product offering price.
Show Source
Nested Schema : price tag
Type: array
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.
Show Source
  • 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.
Nested Schema : balance charge tier bound expression
Type: object
Title: balance charge tier bound expression
Refers to the tier bound expression for balance.
Show Source
Nested Schema : number charge tier bound expression
Type: object
Title: number charge tier bound expression
Refers to the number expression for the charge tier bound.
Show Source
  • Title: value
    Refers to the numeric value for the tier bound. It is Float.POSITIVE_INFINITY for Inf and Float.NEGATIVE_INFINITY for -Inf.
Nested Schema : AttributeAnalyzerModelJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : modelData
Type: array
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : validityPeriod
Type: array
Show Source
Nested Schema : AAModelDataJXB
Type: object
Show Source
Nested Schema : AAValidityPeriodJXB
Type: object
Show Source
Nested Schema : rule
Type: array
Show Source
Nested Schema : AARuleJXB
Type: object
Show Source
Nested Schema : complexAAExpression
Type: array
Show Source
Nested Schema : crSelectorExpression
Type: array
Show Source
Nested Schema : customExpression
Type: array
Show Source
Nested Schema : fieldToFieldExpression
Type: array
Show Source
Nested Schema : fieldToValueExpression
Type: array
Show Source
Nested Schema : namedResultExpression
Type: array
Show Source
Nested Schema : result
Type: array
Show Source
Nested Schema : ruleData
Type: array
Show Source
Nested Schema : valueMapExpression
Type: array
Show Source
Nested Schema : ComplexAAExpressionJXB
Type: object
Show Source
Nested Schema : AttributeAnalyzerExpressionsJXB
Type: object
Show Source
Nested Schema : CRSelectorExpressionJXB
Type: object
Show Source
Nested Schema : CustomExpressionJXB
Type: object
Show Source
Nested Schema : FieldToFieldExpressionJXB
Type: object
Show Source
Nested Schema : FieldToValueExpressionJXB
Type: object
Show Source
Nested Schema : NamedResultExpressionJXB
Type: object
Show Source
Nested Schema : ValueMapExpressionJXB
Type: object
Show Source
Nested Schema : namedResult
Type: array
Show Source
Nested Schema : AAResultJXB
Type: object
Show Source
Nested Schema : resultData
Type: array
Show Source
Nested Schema : AAResultDataJXB
Type: object
Show Source
Nested Schema : AARuleDataJXB
Type: object
Show Source
Nested Schema : BestPricingJXB
Type: object
Show Source
Nested Schema : alternateBundledProductOffering
Type: array
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : AlternateOfferingJXB
Type: object
Show Source
Nested Schema : condition
Type: array
Show Source
Nested Schema : AlternateConditionJXB
Type: object
Show Source
Nested Schema : BundledProductOfferingJXB
Type: object
A bundled product offering object.
Show Source
  • Title: bill on purchase
    (Optional) Set this Boolean flag to immediately bill purchase fees when the customer buys the bundle. It does not bill other charges, such as recurring, usage, or cancellation fees.
  • bundled product offering item
    Title: bundled product offering item
    Provide details about a charge offer or discount offer inside the bundle. For example, include the purchaseStart, purchaseEnd, usageStart, usageEnd, cycleStart, and cycleEnd fields.
  • Title: changeset
    Refers to the name of the change set of the object.
  • created date
    Title: created date
    The date and time the object was created.
  • Title: create user
    The user that created the object.
  • Title: current state name
    The name of current state of the bundle product offer.
  • Title: customer spec name
    This tag represents "Account" as a service. Possible values are productSpecName or customerSpecName. It is required to provide at least one of these values.
  • Allowed Values: [ "OPTIONAL", "PROHIBITED", "REQUIRED" ]
    Specifies whether a CSR can change a customer's default price and effective time period of a charge or discount offer. For example, PROHIBITED prevents CSRs from making changes, REQUIRED forces CSRs to make changes, and OPTIONAL allows CSRs to make changes, which is the default.
  • Title: description
    The bundled product offer's description.
  • Title: external id
    Enter the external ID for the object. Use it to create cross-references during migration.
  • Title: first usage activation
    (Optional) Boolean flag to activate all charge offers in a bundle on first usage. If true, all charge offers activate when the first charge offer activates. If false (default), activating one charge offer on first usage does not activate the others.
  • Title: group balance elements
    (Optional) Set this Boolean flag to synchronize the start date of all balance elements to the first-usage date when any one activates for the first time. This applies only to balance elements configured to start on first usage, and only to first-usage balance elements granted by offers in the bundle.
  • Title: internal Id
    Unique ID (UUID) internally generated by PDC while committing the pricing configuration.
  • last modified date
    Title: last modified date
    The date and time the object was modified last.
  • Title: last modified user
    The user that modified the object last.
  • Title: name
    The bundled product offer's name.
  • Title: new name
    The bundled product offer's new name.
  • Title: obsolete
    Set this Boolean flag to mark promoted (active) objects as obsolete.
  • Title: price list name
    Configured as Default. It is not recommended to modify this field.
  • Title: pricing profile name
    The pricing profile name determines which features the offer supports. Valid values include Convergent Usage, Product Offering, Standard ChargeSharing, Standard Discount, Subscription ChargeSharing, Subscription Discount, and Subscription. Use Standard Discount for usage events, and use Subscription Discount for one-time and recurring events.
  • product spec characteristic
    Title: product spec characteristic
    Use a key-value pair to define special product characteristics.
  • Title: product spec name
    This field specifies the service type to which the bundled product offering applies. Possible values are productSpecName, customerSpecName. It is required to provide at least one of these values.
  • publishSchemas
  • Title: subscription terms iid
    Internal ID for the subscription terms object.
  • Title: subscription terms name
    Name for the subscription terms object.
  • Title: time range
    (Optional) Specify the purchase start and end dates for when the bundle can be purchased, using the format [YYYYMMDDTHHMMSS/YYYYMMDDTHHMMSS]. The default is 0/inf. For the start date, enter Immediately or a specific date and time. For the end date, enter inf (never) or a specific date and time. The purchase period excludes the end date; for example, a bundle with start date 20240501T000000 and end date 20240510T000000 is available from May 1 through May 9.
  • Title: version
    The PDC version of the object.
Nested Schema : bundled product offering item
Type: array
Title: bundled product offering item
Provide details about a charge offer or discount offer inside the bundle. For example, include the purchaseStart, purchaseEnd, usageStart, usageEnd, cycleStart, and cycleEnd fields.
Show Source
  • BundledProductOfferingItemJXB
    Provides details about a charge offer or discount offer within the bundle. For example, it can include fields such as purchaseStart, purchaseEnd, usageStart, usageEnd, cycleStart, and cycleEnd.
Nested Schema : created date
Type: object
Title: created date
The date and time the object was created.
Nested Schema : last modified date
Type: object
Title: last modified date
The date and time the object was modified last.
Nested Schema : product spec characteristic
Type: array
Title: product spec characteristic
Use a key-value pair to define special product characteristics.
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : BundledProductOfferingItemJXB
Type: object
Provides details about a charge offer or discount offer within the bundle. For example, it can include fields such as purchaseStart, purchaseEnd, usageStart, usageEnd, cycleStart, and cycleEnd.
Show Source
  • 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" ]
    (Optional) Specifies that the charge offer can be purchased as an add-on product after the bundle has been purchased. The validity mode for the add-on charge offer can be set to BASE_OFFER, which aligns the validity dates with the base charge offer and requires the inclusion of the baseChargeOfferingName field. BASE_OFFER_EXPIRY_FIRST aligns the validity dates with the active base charge offer that expires first, while BASE_OFFER_EXPIRY_LAST aligns them with the one that expires last. BASE_OR_ADD_ON_OFFER_EXPIRY_FIRST aligns the validity with the active charge offer (base or add-on) that expires first, and BASE_OR_ADD_ON_OFFER_EXPIRY_LAST aligns it with the one that expires last.
  • Title: alteration offering name
    Displays the name of the discount offer. This field is not editable.
  • Title: base charge offering name
    The name of the base charge offer on which to set the validity dates for an add-on offer. Note- Include this field only when addOnOfferingValidityMode is set to BASE_OFFER.
  • Title: charge offering name
    Displays the name of the charge offer. This field is not editable.
  • Title: cycle charge adjustment
    (Optional) Specifies the adjustments to apply to the offer's recurring charges. The default value is 0.
  • ValidityJXB
    Defines the object validity.
  • ValidityJXB
    Defines the object validity.
  • Title: grace period offset
    (Optional) Specifies the length of the grace period during which an additional offer can be purchased as an extension of an existing subscription. For example, a value of 0 indicates no grace period. This field applies only when purchaseMode is set to EXTEND or OVERWRITE.
  • Allowed Values: [ "DAY", "HOUR", "MINUTE", "SECOND" ]
    (Optional) Specifies the unit of the grace period defined in gracePeriodOffset. Valid values are SECOND, MINUTE, HOUR, and DAY, with DAY as the default. This field applies only when purchaseMode is set to EXTEND or OVERWRITE.
  • Allowed Values: [ "PRORATE_30_DAYS", "PRORATE_DAYS_IN_MONTH" ]
    Specifies the number of days in a month used to calculate a prorated cycle charge or discount in an offer. PRORATE_30_DAYS calculates the proration based on a 30-day month, while PRORATE_DAYS_IN_MONTH uses the actual number of days in the month, such as 30 for June or 31 for May. If not set or missing, the system applies the proration according to the system-wide setting in the CM pin.conf file.
  • Title: purchase charge adjustment
    (Optional) Specifies the adjustment to apply to the offer's purchase and cancel charges. The default value is 0.
  • ValidityJXB
    Defines the object validity.
  • Allowed Values: [ "EXTEND", "EXTEND_NEW_SUB_BAL", "LONGEST_DATE", "LONGEST_DATE_NEW_SUB_BAL", "NEW_INSTANCE", "OVERWRITE" ]
    (Optional) Specifies how the offer is applied when customers purchase the same charge offer or discount offer more than once. Valid values include NEW_INSTANCE, which purchases the additional offer as a new, unrelated subscription (default); LONGEST_DATE, which extends the existing subscription if purchased within the grace period; EXTEND, which also extends the existing subscription if purchased within the grace period; and OVERWRITE, which replaces the existing subscription with the new one.
  • ValidityJXB
    Defines the object validity.
  • Title: quantity
    (Optional) Specifies the number of charge offers or discount offers included in the bundle. The default value is 1. For example, if a bundle for a cable service includes a charge offer that provides one set-top box and you want to include three set-top boxes, enter 3 for the charge offer in that bundle
  • Title: renewal mode
    (Optional) Specifies how to align recurring charge offers when a customer suspends and then reactivates a bundle. For example, true aligns the recurring charge offer as follows - when cycleFeeFlag is set to 0, the cycle aligns with the billing date; when cycleFeeFlag is 1 and purchaseCycleDOM is not set, the cycle aligns with the reactivation date; and when cycleFeeFlag is 1 and purchaseCycleDOM is set, the cycle aligns with either purchaseCycleDOM or the reactivation date, whichever is later. false aligns the recurring charge offer according to the setting in purchaseCycleDOM, which is the default.
  • Title: status
    (Optional) Specifies the initial status of the product offering. The possible values are 1 (active) or 0 (inactive). The default value is 1.
  • Title: status code
    (Optional) A customer-defined reason code if a product offering's status is inactive.
  • Title: usage charge adjustment
    (Optional) Specifies the adjustments to apply to an offer's usage charge. The default value is 0.
  • ValidityJXB
    Defines the object validity.
  • ValidityJXB
    Defines the object validity.
Nested Schema : ValidityJXB
Type: object
Defines the object validity.
Show Source
  • Allowed Values: [ "FIRST_USAGE", "NOW_TO_NEVER", "RELATIVE" ]
    Specifies the activation mode. Common options include NOW_TO_NEVER (immediate activation) and FIRST_USAGE.
  • Specifies the number of time units before activation. For example, 2 days indicates that activation occurs two days after the start.
  • Allowed Values: [ "CYCLE", "DAY", "HOUR", "MINUTE", "MONTH", "SECOND" ]
    Specifies the unit of the purchase start, for example, days, months, or cycle
Nested Schema : BundledProductOfferingDependencyJXB
Type: object
Defines dependent relationships between bundles.
Show Source
Nested Schema : created date
Type: object
Title: created date
The date and time the object was created.
Nested Schema : last modified date
Type: object
Title: last modified date
The date and time the object was modified last.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : BundledProductOfferingTransitionJXB
Type: object
Defines rules for transitioning from one bundle to another.
Show Source
  • Title: active
    Specifies whether the transition rule is enabled and available for subscribers. When active, customers can perform the upgrade or downgrade according to the defined rule. When not active, the system disables the transition, making it unavailable for subscriber operations.
  • Title: changeset
    Refers to the name of the change set of the object.
  • created date
    Title: created date
    The date and time the object was created.
  • Title: created user
    The user that created the object
  • Title: current state name
    The object's current state.
  • Title: customer spec name
    Specifies the tag used for Account as a service.
  • Title: description
    Provides a description of the Bundled Product Offering Transition object.
  • Title: external id
    Uses the external ID of this object to create cross-references during migration.
  • Title: from bundled product offering name
    Specifies the name of the source bundled product offering from which this transition rule moves.
  • Title: internal id
    Uses a unique ID (UUID) that the PDC system generates internally when committing the pricing configuration.
  • last modified date
    Title: last modified date
    The date and time the object was modified last.
  • Title: last modified user
    The user that modified the object last.
  • Title: name
    Specifies the unique name of the Bundled Product Offering Transition object.
  • Title: new name
    Specifies the new name for the Bundled Product Offering Transition object.
  • Title: obsolete
    Set this Boolean flag to mark promoted (active) objects as obsolete.
  • Title: price list name
    Specifies the configuration mode, which is set to Default by default. Keep it as Default.
  • Title: pricing profile name
    Specifies the name of the pricing profile, which determines the features the system enables for the offer. Possible values include Convergent Usage, Product Offering, Standard ChargeSharing, Standard Discount, Subscription ChargeSharing, Subscription Discount, and Subscription. For example, the system uses Standard Discount for usage events and Subscription Discount for one-time and recurring events.
  • Title: product spec name
    The service type to which the bundled product offering transition applies.
  • Allowed Values: [ "ORIGINAL_CHARGE", "PRORATE_CHARGE", "TRANSFER_CHARGE" ]
    Specifies the prorationType setting, which determines whether charges are prorated (split), fully charged for the old bundle, or fully charged for the new bundle when a transition occurs partway through a billing cycle. The default value is PRORATE_CHARGE.
  • publishSchemas
  • Title: time range
    (Optional) Specifies the purchase start and end dates for the bundle in the format [YYYYMMDDTHHMMSS/YYYYMMDDTHHMMSS]. The default is 0/inf. For the start date, you can enter Immediately or a specific date and time. For the end date, you can enter inf (never) or a specific date and time. The system excludes the end date from the purchase period; for example, a bundle with a start date of May 1 and an end date of May 10 is available from May 1 through May 9.
  • Title: to bundled product offering name
    Specifies the name of the target bundled product offering to which this transition rule moves.
  • Allowed Values: [ "DOWNGRADE", "UPGRADE" ]
    Bundled Product Offering Transition Type- Downgrade or Upgrade.
  • Title: version
    The PDC version of the object.
  • Title: waive cancel fee
    Specifies whether the system charges the customer a cancellation fee for the old bundle during the transition.
  • Title: waive purchase fee
    Specifies whether the system charges the customer a purchase fee for the new bundle during the transition.
Nested Schema : created date
Type: object
Title: created date
The date and time the object was created.
Nested Schema : last modified date
Type: object
Title: last modified date
The date and time the object was modified last.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : ChargeOfferingJXB
Type: object
Refers to the charge offer pricing object.
Show Source
  • 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.
  • Title: change set name
    Refers to the name of the change set of the charge offer.
  • chargeEventMap
    The charge event map.
  • created date
    Title: created date
    Refers to the date and time the object was created.
  • Title: created user
    Refers to the user that created the object.
  • Title: current state name
    Refers to the name of current state of the charge offer.
  • (required) The tag used for Account as a service. One of the fields customerSpecName and productSpecName are required and they are mutually exclusive.
  • 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
  • Title: description
    Describes the charge offer.
  • 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>.
  • Title: External id of charge offer.
    Refers to the object's external ID. It is used to create cross references, in case of migration.
  • 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.
  • Title: internal id
    Refers to the Unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration was committed.
  • last modified date
    Title: last modified date
    Refers to the date and time the object was modified.
  • Title: last modified user
    Refers to the user that modified the object.
  • Title: name
    The charge offer's name.
  • Title: new name
    Refers to the new name given to the already named charge offer.
  • Title: obsolete
    Set this Boolean flag to mark promoted (active) objects as obsolete.
  • 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.
  • 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.
  • 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.
  • Title: partial
    Enables partial purchases.
  • 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.
  • Title: price list name
    The name of the price list. By default, this is configured as Default. Keep the value as Default.
  • priceTag
  • Title: pricing profile name
    Determines which features are supported for the charge based on the charge category and charge type.
  • 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
    Defines custom attributes and their valid values for a charge offer.
  • (required) 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Allowed Values: [ "OFF", "ON" ]
    Specifies whether to calculate the scale based on validityRounding.
  • Title: subscription due notification
    Triggers notifications to be sent to the customer before the subscription is due for renewal. The default value is true.
  • Title: tax exemption selector id
    Refers to the tax exemption selector's ID.
  • Title: tax exemption selector name
    The name of the tax exemption selector.
  • Title: tax supplier
    Refers to the tax supplier's name for the charge offer.
  • 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.
  • 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.
  • Title: charge offer version
    Refers to the Pricing Design Center version of the object.
Nested Schema : chargeEventMap
Type: array
The charge event map.
Show Source
Nested Schema : created date
Type: object
Title: created date
Refers to the date and time the object was created.
Nested Schema : deliverable
Type: array
Show Source
Nested Schema : last modified date
Type: object
Title: last modified date
Refers to the date and time the object was modified.
Nested Schema : priceTag
Type: array
Show Source
Nested Schema : productSpecCharacteristic
Type: array
Defines custom attributes and their valid values for a charge offer.
Show Source
Nested Schema : ChargeEventMapJXB
Type: object
Show Source
  • ChargeRatePlanInfoJXB
    Indicates to which rating engine(s) the charge rate plan is published.
  • (required) 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.
  • (required) The charge selector's name. One of the fields chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive..
  • Title: charge event description
    Describes the charge event map configured.
  • Title: charge event name
    Refers to the event's name.
  • 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).
  • Title: rum round increment quantity unit
    Refers to the units that increment quantity is specified in. Possible values are .
  • 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.
  • Title: rum min quantity unit
    Refers to the unit in which the minimum quantity is expressed. Possible values are none, second, minute, hour, day.
  • 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.
  • 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.
  • 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.
  • Title: rate plan id
    The charge rate plan's ID generated internally by the PDC system for the charge event map.
  • Title: rate plan selector id
    The charge selector's ID generated internally by the PDC system for the charge event map.
  • (required) The rollover rate plan's name. One of the fiels chargeRatePlanSelectorName, chargeRatePlanName, or rolloverRatePlanName are required and they are mutually exclusive.
  • Allowed Values: [ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]
    Specifies how a RUM quantity is rounded.
  • Title: rum name
    The name of the RUM. RUMs specify the units used to measure an event and how to calculate the measurement.
  • Allowed Values: [ "ACCOUNT", "EVENT", "SERVER" ]
    Determines the time zone used to rate an event.
  • Title: charge valid if canceled
    Specifies to charge even if the instantiated product offering status is canceled. The default value is true.
  • Title: charge valid if inactive
    Specifies to charge even if the instantiated product offering status is inactive. The default value is true.
  • 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.
Nested Schema : ChargeRatePlanInfoJXB
Type: object
Indicates to which rating engine(s) the charge rate plan is published.
Show Source
Nested Schema : charge rate plan target engine
Type: array
Title: charge rate plan target engine
Refers to the target engine where the information about the charge offer is to be published.
Show Source
Nested Schema : ChargeOfferDeliverableJXB
Type: object
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.
Show Source
Nested Schema : ChargeRatePlanJXB
Type: object
Refers to the charge rate plan pricing object.
Show Source
  • Allowed Values: [ "CONTINUOUS", "ISOLATED" ]
    Indicates if the applicable quantity should be treated continuous or isolated.
  • 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
    (required) 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.
  • 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.
  • Title: bill offset
    Specifies the offset (number of days or months) to bill in advance.
  • Title: change set name
    The name of the Change set of the charge rate plan.
  • creation date
    Title: creation date
    Refers to the date and time the object was created.
  • Title: creator
    Refers to the user that created the object.
  • crpAttributeAnalyzerModel
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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.
  • Title: current state name
    The name of the current state of the charge rate plan.
  • Title: cycle fee flag
    Specifies how to align recurring charges. '0' for billing date, '1' puchase date.
  • Title: description
    Describes the charge rate plan.
  • enhancedZoneModel
    (required) 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.
  • 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
    (required) 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.
  • Title: internal id
    The unique ID (UUID) internally generated by Pricing Design Center while the pricing configuration is commited.
  • modification date
    Title: modification date
    Refers to the date and time the object was modified.
  • Title: modifier
    Refers to the user that modified the object.
  • Title: name
    The name of the charge rate plan.
  • Title: new name
    The new name given to the already named charge rate plan.
  • Title: obsolete
    Set this Boolean flag to mark promoted (active) objects as obsolete.
  • Allowed Values: [ "DAYS", "MONTHS" ]
    Specifies the offset unit (days or months) to bill in advance.
  • Title: permitted name
    Refers to the service to which the charge applies.
  • Allowed Values: [ "CUSTOMER", "PRODUCT" ]
    Specifies whether it is a product or a customer type.
  • Title: price list name
    Name of the price list. By default, this is configured as Default. Keep the value as Default.
  • 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.
  • ARatePlanElementJXB
  • subscriberCurrency
  • 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.
  • 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.
  • 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.
  • Allowed Values: [ "BILLING_TIME", "DYNAMIC", "EVENT_TIME", "NONE", "TAX_INCLUDED" ]
    Refers to the time when the charge is taxed.
  • timeConfiguration
    (required) 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.
  • 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.
  • Title: pdc version
    Refers to the Pricing Design Center version of the object.
  • zoneModel
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : applicable rums
Type: array
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.
Show Source
Nested Schema : creation date
Type: object
Title: creation date
Refers to the date and time the object was created.
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : ARatePlanElementJXB
Type: object
Show Source
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : applicable rum rate plan branch
Type: object
Title: applicable rum rate plan branch
RUMs are ways in which you can measure events.
Show Source
  • applicableRum
    (required) 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.
  • 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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
    (required) 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
    (required) 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.
  • 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.
  • Allowed Values: [ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]
    Measures the RUM quantity.
  • Title: min quantity
    The minimum value that the RUM quantity is rounded to. A value smaller than min_quantity is rounded to min_quantity.
  • Allowed Values: [ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]
    Measures the RUM quantity.
  • Allowed Values: [ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]
    Specifies how a RUM quantity is rounded.
  • subscriberCurrency
  • timeConfiguration
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : applicable rum name
Type: array
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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) The time model configuration. It is required and has to be one of subscriberCurrency, applicableRum, genericSelector, crpDateRange, crpRelDateRange, crpAttributeAnalyzerModel, zoneModel, enhancedZoneModel, crpCompositePopModel, or timeConfiguration.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : charge rate attribute analyzer rate plan element
Type: object
Title: charge rate attribute analyzer rate plan element
A container object used for modeling expressions based on event, product and customer attributes.
Show Source
  • Title: attribute analyzer model name
    The attribute analyzer model's name.
  • 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.
Nested Schema : charge rate date range
Type: object
Title: charge rate date range
Describes the date range validity of the charge rate plan.
Show Source
Nested Schema : CR absolute date range
Type: object
Title: CR absolute date range
A container that defines the effective date range for a fixed period.
Show Source
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
Show Source
Nested Schema : crpRelDateRange
Type: array
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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..
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
Show Source
  • 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.
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : charge rate release date range
Type: object
Title: charge rate release date range
Describes the relative date range validity of the charge rate plan.
Show Source
  • CR absolute date range
    Title: CR absolute date range
    A container that defines the effective date range for a fixed period.
  • applicableRum
    (required) 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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
    (required) 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
    (required) 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.
  • relative date range
    Title: relative date range
    A container that defines a relative date range for a product purchase.
  • subscriberCurrency
  • timeConfiguration
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : relative date range
Type: object
Title: relative date range
A container that defines a relative date range for a product purchase.
Show Source
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : enhanced zone RPE
Type: object
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.
Show Source
Nested Schema : zone results
Type: array
Title: zone results
Dscribes the impact category for zones.
Show Source
  • 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.
Nested Schema : zone results
Type: object
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.
Show Source
  • applicableRum
    (required) 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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
    (required) 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
    (required) 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.
  • zone results name
    Title: zone results name
    Name of the zone results.
  • subscriberCurrency
  • timeConfiguration
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : zone results name
Type: array
Title: zone results name
Name of the zone results.
Show Source
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : generic selector rate plan element
Type: object
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.
Show Source
Nested Schema : attribute analyzer results
Type: array
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.
Show Source
  • 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.
Nested Schema : attribute analyzer results
Type: object
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.
Show Source
  • applicableRum
    (required) 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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
    (required) 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
    (required) 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
    Title: name
    The attribute analyzer result's name.
  • subscriberCurrency
  • timeConfiguration
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : name
Type: array
Title: name
The attribute analyzer result's name.
Show Source
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : ChargeRateSubscriberCurrencyRPEJXB
Type: object
(required) 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.
Show Source
  • applicableRum
    (required) 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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.
  • currency code
    Title: currency code
    The three letter ISO code for Currency
  • enhancedZoneModel
    (required) 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
    (required) 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
    (required) 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
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : currency code
Type: array
Title: currency code
The three letter ISO code for Currency
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : subscriberCurrency
Type: array
(required) 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.
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : charge rate time rate plan element
Type: object
Title: charge rate time rate plan element
Specifies the time model configuration.
Show Source
Nested Schema : time tags
Type: array
Title: time tags
Specifies the time tags.
Show Source
Nested Schema : time tags
Type: object
Title: time tags
Specifies the time tags.
Show Source
  • applicableRum
    (required) 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
    (required) 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.
  • CompositePopModelRPEJXB
    Refers to the generic product offering price model. It can be one-time, recurring, or usage type.
  • crpDateRange
    (required) 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
    (required) 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
    (required) 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
    (required) 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.
  • time tag name
    Title: time tag name
    The time tag's name.
  • subscriberCurrency
  • timeConfiguration
    (required) 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
    (required) 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.
Nested Schema : applicableRum
Type: array
(required) 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.
Show Source
Nested Schema : crpAttributeAnalyzerModel
Type: array
(required) 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.
Show Source
Nested Schema : crpDateRange
Type: array
(required) 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.
Show Source
Nested Schema : crpRelDateRange
Type: array
(required) 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.
Show Source
Nested Schema : enhancedZoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : genericSelector
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : time tag name
Type: array
Title: time tag name
The time tag's name.
Show Source
Nested Schema : subscriberCurrency
Type: array
Show Source
  • ChargeRateSubscriberCurrencyRPEJXB
    (required) 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.
Nested Schema : timeConfiguration
Type: array
(required) 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.
Show Source
Nested Schema : zoneModel
Type: array
(required) 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.
Show Source
  • 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.
Nested Schema : zone model RPE
Type: object
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.
Show Source
Nested Schema : zone results
Type: array
Title: zone results
Describes the impact category for zones.
Show Source
  • 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.
Nested Schema : ChargeSelectorSpecJXB
Type: object
Show Source
Nested Schema : balanceElementNumCode
Type: array
The numeric code for the balance element.
Show Source
Nested Schema : chargeRatePlanName
Type: array
The name of the rate plan.
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : eventConditions
Type: array
Show Source
Nested Schema : glid
Type: array
The general ledger (G/L) ID.
Show Source
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : priceModelName
Type: array
The name of the price model.
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : rumName
Type: array
The name of the RUM.
Show Source
Nested Schema : timeModelName
Type: array
The name of the time model.
Show Source
Nested Schema : zoneModelName
Type: array
The name of the zone model.
Show Source
Nested Schema : ChargeSelectorEventConditionJXB
Type: object
Show Source
Nested Schema : DistributionOfferingJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : distributionEventMap
Type: array
Show Source
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : productSpecCharacteristic
Type: array
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : DistributionEventMapJXB
Type: object
Show Source
Nested Schema : DistributionRatePlanJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : distributionConfiguration
Type: array
Show Source
Nested Schema : drpDateRange
Type: array
Show Source
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : DistributionRPEBranchJXB
Type: object
Show Source
Nested Schema : chargeSelectorSpecName
Type: array
Show Source
Nested Schema : distributionConfiguration
Type: array
Show Source
Nested Schema : drpDateRange
Type: array
Show Source
Nested Schema : DistributionDateRangeRPEBranchJXB
Type: object
Show Source
Nested Schema : distributionConfiguration
Type: array
Show Source
Nested Schema : drpDateRange
Type: array
Show Source
Nested Schema : PackageJXB
Type: object
A package includes one or more bundles available for customers to purchase.
Show Source
Nested Schema : balanceSpecification
Type: array
Title: balanceSpecification
By default, the account balance group tracks balances for all services. To track balances for specific services in a package, associate those services with their own balance groups. For each balance group, specify credit limits, credit thresholds, and consumption rules for its balance elements.
Show Source
  • BalanceSpecificationJXB
    By default, balances for all services are tracked in the account balance group. To track balances for specific services in the package, you associate the services with their own balance groups. For each balance group, you can specify credit limits, credit thresholds, and consumption rules for balance elements used by the services in that group.
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : CustomerSpecPackageItemJXB
Type: object
Specifies the tag used to hold the bundle association attributes under Account in a package.
Show Source
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date and time the object was modified last.
Nested Schema : productSpecCharacteristic
Type: array
Title: productSpecCharacteristic
Use a key-value pair to define special product characteristics.
Show Source
Nested Schema : productSpecPackageItem
Type: array
Title: productSpecPackageItem
Use this tag to hold bundle association attributes under "Service*" in a package (for example, TelcoGsmSms).
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : BalanceSpecificationJXB
Type: object
By default, balances for all services are tracked in the account balance group. To track balances for specific services in the package, you associate the services with their own balance groups. For each balance group, you can specify credit limits, credit thresholds, and consumption rules for balance elements used by the services in that group.
Show Source
Nested Schema : balance element specification
Type: array
Title: balance element specification
Specifies the balance element information. A balance element represents a currency or noncurrency asset of economic value, such as U.S. dollars or included minutes.
Show Source
Nested Schema : BalanceElementSpecificationJXB
Type: object
Specifies the balance element information. Represents a currency or noncurrency asset of economic value, such as U.S. dollars or included minutes.
Show Source
  • BalanceCreditProfileJXB
    The maximum amount of a balance element that can accumulate in a balance group. When a credit limit is reached, businesses typically deny customers access to the services associated with the balance group.
  • Title: balance element num code
    Specifies the numeric code for the balance element. For example, 640 represents US dollars.
  • 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" ]
    Specify the order in which sub-balances of a balance element are consumed.
Nested Schema : BalanceCreditProfileJXB
Type: object
The maximum amount of a balance element that can accumulate in a balance group. When a credit limit is reached, businesses typically deny customers access to the services associated with the balance group.
Show Source
Nested Schema : threshold level
Type: array
Title: threshold level
A threshold level specifies the balance limit fixed or percentage that triggers a notification to the customer.
Show Source
Nested Schema : ThresholdLevelJXB
Type: object
A threshold level specifies the balance limit fixed or percentage that triggers a notification to the customer.
Show Source
  • Title: threshold
    Threshold value at which a notification to occur.
  • Allowed Values: [ "ABSOLUTE", "ABSOLUTE_LOAN", "PERCENTAGE", "PERCENTAGE_LOAN" ]
    Threshold notification can be for information on credit limit crossed or may be to offer loan once threshold is crossed.
Nested Schema : BundledProductOfferingAssociationJXB
Type: object
Specifies the bundled product offering assocation.
Show Source
Nested Schema : ProductSpecPackageItemJXB
Type: object
Tag used for holding the bundle association attributes under "Service*" (such as TelcoGsmSms, TelcoGsmSms, and so on) in a package.
Show Source
Nested Schema : bundled product offering association
Type: array
Title: bundled product offering association
Specifies the bundled product offering assocation.
Show Source
Nested Schema : sub package item
Type: array
Title: sub package item
For nested package Item- Tag used for holding the bundle association attributes under "Service*" (such as TelcoGsmSms, TelcoGsmSms, and so on) in a package.
Show Source
Nested Schema : PackageExclusionJXB
Type: object
Specify the discount offers that cannot be used with the package.
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date and time the object was modified last.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : PackageListJXB
Type: object
A package list is used to group related packages that can be made available to customer.
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date and time the object was modified last.
Nested Schema : packageName
Type: array
Title: packageName
The name of the package part of the package list.
Show Source
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : PackageTransitionJXB
Type: object
A package includes one or more bundles available for customers to purchase. Use transition rules to upgrade or downgrade a package to another package.
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date and time the object was modified last.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : PriceModelJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : lastModifiedDate
Type: object
Title: lastModifiedDate
The date the object was last modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : RolloverRatePlanJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : RolloverRateDateRangeJXB
Type: object
Show Source
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : SubscriptionTermsJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : SubscriptionTermsAutoRenewJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : TimeModelJXB
Type: object
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : validityPeriod
Type: array
Show Source
Nested Schema : TimeModelValidityPeriodJXB
Type: object
Show Source
Nested Schema : timeModelTag
Type: array
Show Source
Nested Schema : TimeModelTagJXB
Type: object
Show Source
Nested Schema : timeSpecification
Type: array
Show Source
Nested Schema : TimeSpecJXB
Type: object
Show Source
Nested Schema : DaysOfWeekJXB
Type: object
Show Source
Nested Schema : MonthsOfYearJXB
Type: object
Show Source
Nested Schema : day
Type: array
Show Source
  • Allowed Values: [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ]
Nested Schema : month
Type: array
Show Source
  • Allowed Values: [ "APR", "AUG", "DEC", "FEB", "JAN", "JUL", "JUN", "MAR", "MAY", "NOV", "OCT", "SEP" ]
Nested Schema : TriggerSpecJXB
Type: object
Show Source
Nested Schema : chargeTriggerExpressionOrQuantityTriggerExpressionOrBalanceTriggerExpression
Type: array
Show Source
Nested Schema : createdDate
Type: object
Title: createdDate
The date and time the object was created.
Nested Schema : modification date
Type: object
Title: modification date
Refers to the date and time the object was modified.
Nested Schema : publishSchemas
Type: array
Show Source
Nested Schema : ATriggerExpressionJXB
Type: object
Show Source
Back to Top

Response

201 Response

The pricing object was created successfully.

400 Response

The request isn't valid.

500 Response

An internal service error occurred.
Back to Top

Examples

This example shows how to create a charge offer by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://hostname:port/pdc/pricing' -d @chargeoffer.json

where:

  • hostname is the URL for the PDC REST server.

  • port is the port for the PDC REST server.

  • chargeoffer.json is the JSON file that specifies the details of the charge offer to create.

Example of Request Body

The following is an example of the contents of the chargeoffer.json file sent as the request body. 

{
   "chargeOffering": [
      {
         "name": "sample_CO_jan27",
         "pricingProfileName": "Product Offering",
         "priceListName": "Default",
         "obsolete": false,
         "timeRange": "0/inf",
         "productSpecName": "TelcoGsmTelephony",
         "offerType": "SUBSCRIPTION",
         "priority": 0,
         "partial": false,
         "purchaseMin": -1,
         "purchaseMax": -1,
         "ownMin": -1,
         "ownMax": -1,
         "applicableQuantity": "REMAINING",
         "purchaseCycleDOM": 0,
         "expiryNotification": true,
         "subscriptionDueNotification": true,
         "dateRangeImpactType": "EVENT_DATE",
         "groupSharingEnabled": false,
         "validityRounding": "off",
         "scaleRounding": "off",
         "chargeEventMap": [
            {
               "eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
               "validIfCancelled": true,
               "validIfInactive": true,
               "validIfSuspendedActive": true,
               "timezoneMode": "EVENT",
               "minQuantity": 0,
               "minQuantityUnit": "NONE",
               "incrementQuantity": 1,
               "incrementQuantityUnit": "NONE",
               "roundingMode": "NEAREST",
               "prorateFirst": "PRORATE_CHARGE",
               "prorateLast": "PRORATE_CHARGE",
               "prorateCycle": "PRORATE_CHARGE",
               "chargeRatePlanInfo": {
                  "targetEngine": [
                     "RRE"
                  ]
               },
               "chargeRatePlanName": "sample_CRP_jan27"
            }
         ]
      }
   ]
}

Example of Response Body

If successful, the response code 201 is returned with no response body.

Back to Top