Update a product offering price
patch
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/{id}
Updates the product offering price with the specified ID.
Request
Path Parameters
-
id(required): string
The ID of the resource item.
Supported Media Types
- application/json
Root Schema : ProductOfferingPrice_Schemas
Type:
objectTitle:
ProductOfferingPrice_SchemasDiscriminator: @type
Discriminator Values
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
- ProductOfferingBeatPriceOracle
The product offering price resource.
Match One Schema
Show Source
-
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
ProductOfferingPriceAlterationOracle
Title:
ProductOfferingPriceAlterationOracle -
ProductOfferingPriceAllowanceOracle
Title:
ProductOfferingPriceAllowanceOracle -
ProductOfferRolloverPriceOracle
Title:
ProductOfferRolloverPriceOracle -
ProductOfferingPriceCounterOracle
Title:
ProductOfferingPriceCounterOracle -
ProductOfferingPriceOverageOracle
Title:
ProductOfferingPriceOverageOracle -
ProductOfferingPricePlanOracle
Title:
ProductOfferingPricePlanOracle -
PenaltyPriceOracle
Title:
PenaltyPriceOracle -
ProductOfferingBeatPriceOracle
Title:
ProductOfferingBeatPriceOracle
Nested Schema : ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracleMatch All
Show Source
-
object
ProductOfferingPrice
Title:
ProductOfferingPriceDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }The product offering price resource. -
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
Nested Schema : ProductOfferingPriceAlterationOracle
Title:
ProductOfferingPriceAlterationOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceAlterationOracle-allOf[1]
Nested Schema : ProductOfferingPriceAllowanceOracle
Title:
ProductOfferingPriceAllowanceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceAllowanceOracle-allOf[1]
Nested Schema : ProductOfferRolloverPriceOracle
Title:
ProductOfferRolloverPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferRolloverPriceOracle-allOf[1]
Nested Schema : ProductOfferingPriceCounterOracle
Title:
ProductOfferingPriceCounterOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceCounterOracle-allOf[1]
Nested Schema : ProductOfferingPriceOverageOracle
Title:
ProductOfferingPriceOverageOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceOverageOracle-allOf[1]
Nested Schema : ProductOfferingPricePlanOracle
Title:
ProductOfferingPricePlanOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPricePlanOracle-allOf[1]
Nested Schema : PenaltyPriceOracle
Title:
PenaltyPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
PenaltyPriceOracle-allOf[1]
Nested Schema : ProductOfferingBeatPriceOracle
Title:
ProductOfferingBeatPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingBeatPriceOracle-allOf[1]
Nested Schema : ProductOfferingPrice
Type:
objectTitle:
ProductOfferingPriceDiscriminator: @type
Discriminator Values
- ProductOfferingPrice
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferingBeatPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
The product offering price resource.
Show Source
-
@baseType: string
The base type of the product offering price.
-
@schemaLocation: string
The URI of the schema that defines the product offering price.
-
@type(required): string
The class type of the product offering price.
-
alterationBasedOn: object
AlterationBasedOnOracle
Title:
AlterationBasedOnOracleA number, unit and an expression representing the relative alteration. -
alterationExpression: array
alterationExpression
A list of alteration expressions associated with the product offering price.
-
billOnPurchase: boolean
Whether the product offering price has bill on purchase.
-
bundledPopRelationship: array
bundledPopRelationship
A list of bundled pop relationships associated with the product offering price.
-
description: string
The description of the product offering price.
-
discountable: boolean
Whether the product offering price is discountable.
-
glid: string
The general ledger ID associated with the product offering price.
-
href: string
The hyperlink reference to the product offering price.
-
id: string
Maximum Length:
30The ID of the product offering price. -
isBundle: boolean
Whether the product offering price is bundle.
-
lastUpdate: string
(date-time)
The date and time when the product offering price was last updated.
-
lifecycleStatus: string
The status of the product offering price.
-
name: string
The name of the product offering price.
-
percentage: number
The percentage to apply for ProdOfferPriceAlteration.
-
place: array
place
A list of places associated with the product offering price.
-
policy: array
policy
A list of policies associated with the product offering price.
-
popRelationship: array
popRelationship
A list of pop relationships associated with the product offering price.
-
price: object
Money
Title:
MoneyThe amount of money that characterizes the price. -
priceType: string
Allowed Values:
[ "RECURRING", "ONE_TIME", "USAGE", "ALTERATION", "ALLOWANCE", "ALLOWANCE_GRANT", "OVERAGE", "PENALTY", "ONE_TIME_PRICE_PLAN", "RECURRING_PRICE_PLAN", "USAGE_PRICE_PLAN", "ALTERATION_PRICE_PLAN", "OVERAGE_PRICE_PLAN", "COUNTER", "ROLLOVER" ]The type or classification of the product offering price. -
pricingLogicAlgorithm: array
pricingLogicAlgorithm
A list of pricing logic algorithms associated with the product offering price.
-
prodSpecCharValueUse: array
prodSpecCharValueUse
A list of prod specification characteristic value uses associated with the product offering price.
-
productOfferingTerm: array
productOfferingTerm
A list of product offering terms associated with the product offering price.
-
recurringChargePeriodLength: integer
The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1.
-
recurringChargePeriodType: string
Allowed Values:
[ "MONTHLY", "BI_MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "ANNUAL", "DAILY" ]The type or classification of the product offering price. Valid values are MONTHLY, BI_MONTHLY, QUARTERLY, SEMI_ANNUAL, ANNUAL, and DAILY. -
specCharValueUse: array
specCharValueUse
A list of spec characteristic value uses associated with the product offering price.
-
tax: array
tax
A list of taxes associated with the product offering price.
-
unitOfMeasure: object
Quantity
Title:
QuantityA number and unit representing how many of an ProductOffering is available at the offered price. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The product offering price version.
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferingBeatPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
-
alterationAppliedOn: string
Allowed Values:
[ "USER_BALANCE", "SHARER_BALANCE" ]Indicates sharing option for the alteration price. Valid values are USER_BALANCE and SHARER_BALANCE. -
applicationName: string
The name of the application associated with the product offering price.
-
balanceElement: array
balanceElement
A list of balance elements associated with the product offering price.
-
chargeType: string
Allowed Values:
[ "DEBIT", "CREDIT" ]The type or classification of the product offering price. Valid values are DEBIT, and CREDIT. -
counter: array
counter
A list of counters associated with the product offering price.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
customProfileSpec: array
customProfileSpec
A list of custom profile specifications associated with the product offering price.
-
discountMode: string
Allowed Values:
[ "SEQUENTIAL", "PARALLEL" ]Indicates the mode of processing discounts. Valid values are SEQUENTIAL and PARALLEL. -
externalId: string
The ID of the external associated with the product offering price.
-
isTaxInclusive: boolean
Whether the product offering price is tax inclusive.
-
lastUpdatedBy: string
The name of the person who updated item.
-
oneTimeFeeType: string
Allowed Values:
[ "PURCHASE", "CANCEL", "PENALTY" ]The type or classification of the product offering price. Valid values are PURCHASE, CANCEL, and PENALTY. -
pricelist: array
pricelist
A list of pricelists associated with the product offering price.
-
priceSubType: string
Allowed Values:
[ "INSTALLMENT", "LEASE", "MIN_DOWNPAYMENT", "UPGRADE_FEE", "MIGRATION_FEE", "PRICE_PLA", "DEPOSIT", "DOWNGRADE", "EARLY_TERMINATION", "PURCH_OPTION", "LEASE_TOTAL", "COMPOSITE_ALTRN", "NON_CURRENCY_ALTRN", "LEASE_DEFERRED_AMOUNT", "VALUE_INCREMENT", "VALUE_DECREMENT", "PERCENT_INCREMENT", "PERCENT_DECREMENT" ]The type or classification of the product offering price. -
priceTag: string
The priceTag for the price.
-
priceTagValueObject: object
PriceTagRefOracle
Title:
PriceTagRefOracleThe priceTag reference. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
recurringFeeType: string
Allowed Values:
[ "CYCLE", "CYCLE_ARREAR", "CYCLE_FWD_ARREAR" ]The type or classification of the product offering price. Valid values are CYCLE, CYCLE_ARREAR, and CYCLE_FWD_ARREAR. -
relativeValidFor: object
TimePeriodRelativeOracle
Title:
TimePeriodRelativeOracleThe relative validity period of the related party. -
triggerConditionGroup: array
triggerConditionGroup
A list of trigger condition groups associated with the product offering price.
-
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle -
versionState: number
The version state of the productOfferingPrice.
Nested Schema : ProductOfferingPriceAlterationOracle-allOf[1]
Type:
Show Source
object-
alterationType: string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "CHARGE_SHARE" ]The type or classification of the product offering price alteration. Valid values are DISCOUNT, MARKUP, OVERRIDE, DISCOUNT_OVERRIDE, and CHARGE_SHARE. -
discountEligibility: object
PriceEligibilityOracle
Title:
PriceEligibilityOracleSpecifies the eligibility rule for the offer. -
priority: integer
The priority of this resource represented in numerical value.
Nested Schema : PriceEligibilityOracle
Type:
objectTitle:
PriceEligibilityOracleSpecifies the eligibility rule for the offer.
Show Source
-
active: boolean
Whether the price eligibility has active.
-
description: string
A narrative text describing the eligibility rule.
-
eligibilityExpression: array
eligibilityExpression
A list of eligibility expressions associated with the price eligibility.
-
id: string
A string. Unique identifier of the pricing eligibility rule.
-
name(required): string
The name of the price eligibility.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party.
Nested Schema : eligibilityExpression
Type:
arrayA list of eligibility expressions associated with the price eligibility.
Show Source
-
Array of:
object EligibilityExpressionOracle
Title:
EligibilityExpressionOracleThe eligibility expression resource.
Nested Schema : TimePeriodOracle
Type:
objectTitle:
TimePeriodOracleThe validity period of the related party.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : EligibilityExpressionOracle
Type:
objectTitle:
EligibilityExpressionOracleThe eligibility expression resource.
Show Source
-
@baseType: string
The base type of the eligibility expression.
-
@schemaLocation: string
The URI of the schema that defines the eligibility expression.
-
@type(required): string
The class type of the eligibility expression.
-
expressionRelationship: array
expressionRelationship
A list of expression relationships associated with the eligibility expression.
-
expressionType(required): string
Allowed Values:
[ "ARITHMATIC", "NUMERIC", "LOGICAL", "CHARGE", "QUANTITY", "BALANCE" ]The type or classification of the eligibility expression. Valid values are ARITHMATIC, NUMERIC, LOGICAL, CHARGE, QUANTITY, and BALANCE. -
id(required): string
The ID of the eligibility expression.
-
operator: string
The operator of the expression.
-
value:
value
A discrete value that the relationship can take on.
Nested Schema : expressionRelationship
Type:
arrayA list of expression relationships associated with the eligibility expression.
Show Source
-
Array of:
object ExpressionRelationship
Title:
ExpressionRelationshipThe expression relationship resource.
Nested Schema : value
A discrete value that the relationship can take on.
Match One Schema
Show Source
Nested Schema : ExpressionRelationship
Type:
objectTitle:
ExpressionRelationshipThe expression relationship resource.
Show Source
-
@baseType: string
The base type of the expression relationship.
-
@schemaLocation: string
The URI of the schema that defines the expression relationship.
-
@type(required): string
The class type of the expression relationship.
-
expressionId(required): string
The ID of the expression associated with the expression relationship.
-
href: string
The hyperlink reference to the expression relationship.
-
name: string
The name of the expression relationship.
-
relationshipType(required): string
Allowed Values:
[ "LEFT_HAND_SIDE", "RIGHT_HAND_SIDE" ]The type or classification of the expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.
Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]
Type:
Show Source
object-
allowanceValidity: object
AllowanceValidityOracle
Title:
AllowanceValidityOracleThe validity of allowance. -
ruleName: string
Maximum Length:
50The name of the rule associated with the product offering price allowance. -
rulePriority: number
Indicates the priority of the rule associated.
- shareAllowance: boolean
-
usageUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]Indicates the usage unit.
Nested Schema : AllowanceValidityOracle
Type:
objectTitle:
AllowanceValidityOracleThe validity of allowance.
Show Source
-
startCriteria: string
Allowed Values:
[ "EVENT_OCCURRENCE", "FIRST_USAGE" ]Indicates start criteria of allowance validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE. -
unit(required): string
Allowed Values:
[ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]Indicates the unit of allowance validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE. -
value(required): number
The value assigned to the product offering price allowance.
Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]
Type:
Show Source
object-
rolloverFrequency: string
Allowed Values:
[ "MONTH" ]The period to repeat the rollover for. Valid values are MONTH. -
rolloverRules: array
rolloverRules
A list of rollover rules associated with the product offer rollover price.
Nested Schema : rolloverRules
Type:
arrayA list of rollover rules associated with the product offer rollover price.
Show Source
-
Array of:
object RolloverRuleOracle
Title:
RolloverRuleOracleThe rollover rule resource.
Nested Schema : RolloverRuleOracle
Type:
objectTitle:
RolloverRuleOracleThe rollover rule resource.
Show Source
-
balanceElement: object
BalanceElementRef
Title:
BalanceElementRefThe balance element ref in price. -
balanceElementCode(required): string
Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency.
-
glid: string
The gLID for the rollover charge.
-
id(required): string
Maximum Length:
30The ID of the rollover rule. -
maxCumulativeRolloverAmount: number
The maximum rollover amount that can be accumulated.
-
maximumRolloverCycles: object
MaximumRolloverCycleOracle
Title:
MaximumRolloverCycleOracleIndicates the maximum allowed rollover cycles and the unit. -
maxRolloverAmountPerCycle: number
The maximum amount that can be rolled over in a cycle.
-
unitOfMeasure: string
The unit of measure for which the priceTag rule applies to.
Nested Schema : BalanceElementRef
Type:
objectTitle:
BalanceElementRefThe balance element ref in price.
Show Source
-
@baseType: string
The base type of the balance element reference.
-
@referredType(required): string
The type of the referred balance element reference.
-
@schemaLocation: string
The URI of the schema that defines the balance element reference.
-
@type(required): string
The class type of the balance element reference.
-
href: string
The hyperlink reference to the balance element reference.
-
id(required): string
The ID of the balance element reference.
-
name: string
The name of the balance element reference.
-
version: string
The version of the balance element.
-
versionState: number
The version state of the reference.
Nested Schema : MaximumRolloverCycleOracle
Type:
objectTitle:
MaximumRolloverCycleOracleIndicates the maximum allowed rollover cycles and the unit.
Show Source
-
unit(required): string
Allowed Values:
[ "DAYS", "WEEKS", "MONTHS", "YEARS" ]Indicates the unit of rollover cycle. Valid values are DAYS, WEEKS, MONTHS, and YEARS. -
value(required): number
The value assigned to the rollover rule.
Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]
Type:
Show Source
object-
counterValidity: object
CounterValidityOracle
Title:
CounterValidityOracleThe validity of counter.
Nested Schema : CounterValidityOracle
Type:
objectTitle:
CounterValidityOracleThe validity of counter.
Show Source
-
startCriteria: string
Allowed Values:
[ "EVENT_OCCURRENCE", "FIRST_USAGE" ]Indicates start criteria of counter validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE. -
unit(required): string
Allowed Values:
[ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]Indicates the unit of counter validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE. -
value(required): number
The value assigned to the product offering price counter.
Nested Schema : ProductOfferingPriceOverageOracle-allOf[1]
Type:
objectNested Schema : ProductOfferingPricePlanOracle-allOf[1]
Type:
Show Source
object-
alterationType: string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE" ]The type or classification of the product offering price plan. Valid values are DISCOUNT, MARKUP, OVERRIDE, and DISCOUNT_OVERRIDE. -
compositePopRelationship: array
compositePopRelationship
A list of composite pop relationships associated with the product offering price plan.
-
priceRange: string
Indicates the range of prices this price plan defines.
-
ruleName: string
Maximum Length:
50The name of the rule associated with the product offering price plan. -
rulePriority: number
Indicates the priority of the rule associated.
-
usageSpecMeteringRuleUse: array
usageSpecMeteringRuleUse
A list of usage specification metering rule uses associated with the product offering price plan.
Nested Schema : compositePopRelationship
Type:
arrayA list of composite pop relationships associated with the product offering price plan.
Show Source
-
Array of:
object CompositePopRelationshipOracle
Title:
CompositePopRelationshipOracleThe composite relationship from a parent product offering price to a child product offering price.
Nested Schema : usageSpecMeteringRuleUse
Type:
arrayA list of usage specification metering rule uses associated with the product offering price plan.
Show Source
-
Array of:
object UsageSpecMeteringRuleUse
Title:
UsageSpecMeteringRuleUseThe metering rules used in the usage price plan.
Nested Schema : CompositePopRelationshipOracle
Type:
objectTitle:
CompositePopRelationshipOracleThe composite relationship from a parent product offering price to a child product offering price.
Show Source
-
@baseType: string
The base type of the composite pop relationship.
-
@referredType(required): string
A string. The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
The URI of the schema that defines the composite pop relationship.
-
@type(required): string
The class type of the composite pop relationship.
-
href: string
The hyperlink reference to the composite pop relationship.
-
id(required): string
The ID of the composite pop relationship.
-
name: string
The name of the composite pop relationship.
-
relationshipType: string
Allowed Values:
[ "COMPOSITE" ]The type or classification of the composite pop relationship. Valid values are COMPOSITE. -
version: string
The version of the associated product offering price.
Nested Schema : UsageSpecMeteringRuleUse
Type:
objectTitle:
UsageSpecMeteringRuleUseThe metering rules used in the usage price plan.
Show Source
-
id(required): string
The ID of the usage specification metering rule use.
-
name(required): string
The name of the usage specification metering rule use.
-
usageSpecification(required):
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracleMatch All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
object
UsageSpecificationRefOracle-allOf[1]
Nested Schema : UsageSpecificationRef
Type:
objectTitle:
UsageSpecificationRefDiscriminator: @type
Discriminator Values
The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
The base type of the usage specification reference.
-
@referredType(required): string
The type of the referred usage specification reference.
-
@schemaLocation: string
The URI of the schema that defines the usage specification reference.
-
@type(required): string
The class type of the usage specification reference.
-
href: string
The hyperlink reference to the usage specification reference.
-
id(required): string
The ID of the usage specification reference.
-
name: string
The name of the usage specification reference.
-
version: string
The version of the usage specification.
-
versionState: number
The version state of the reference.
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
usageCode: string
The usage code associated with the usage specification reference.
Nested Schema : PenaltyPriceOracle-allOf[1]
Type:
Show Source
object-
prorationReductionTerm: array
prorationReductionTerm
A list of proration reduction terms associated with the penalty price.
Nested Schema : prorationReductionTerm
Type:
arrayA list of proration reduction terms associated with the penalty price.
Show Source
-
Array of:
object ProrationReductionTerm
Title:
ProrationReductionTermProvides references to Early Termination Fee (ETF) that prorates the ETF for a subscriber based on their contract duration. This proration allows a subscriber to pay less to terminate as more time passes giving them an option to stay on for an additional period in contract to minimize their exit fee.
Nested Schema : ProrationReductionTerm
Type:
objectTitle:
ProrationReductionTermProvides references to Early Termination Fee (ETF) that prorates the ETF for a subscriber based on their contract duration. This proration allows a subscriber to pay less to terminate as more time passes giving them an option to stay on for an additional period in contract to minimize their exit fee.
Show Source
-
durationUnits: string
Allowed Values:
[ "DAYS", "MONTHS", "WEEKS", "YEARS" ]The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS. -
fromOffset: number
The start of the schedule.
-
reductionPercentage: number
The percentage of the amount to be deducted.
Nested Schema : ProductOfferingBeatPriceOracle-allOf[1]
Type:
Show Source
object-
beat: object
BeatOracle
Title:
BeatOracleThe beat is basically the pulse measure used for charging usage quantity.
Nested Schema : BeatOracle
Type:
objectTitle:
BeatOracleThe beat is basically the pulse measure used for charging usage quantity.
Show Source
-
incrementQuantity: number
The usage quantity increment of the beat.
-
incrementQuantityUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit of measure for the incrementQuantity of beat. -
minQuantity: number
The minimum usage quantity of the beat.
-
minQuantityUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit of measure for the minQuantity of beat. -
roundingMode: string
Allowed Values:
[ "DOWN", "DOWN_ALT", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]The rounding strategy applied to beat usage quantities. Valid values are DOWN, DOWN_ALT, FLOOR, FLOOR_ALT, NEAREST, and UP.
Response
Supported Media Types
- application/json
200 Response
The product offering price was updated successfully.
Root Schema : ProductOfferingPrice_Schemas
Type:
objectTitle:
ProductOfferingPrice_SchemasDiscriminator: @type
Discriminator Values
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
- ProductOfferingBeatPriceOracle
The product offering price resource.
Match One Schema
Show Source
-
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
ProductOfferingPriceAlterationOracle
Title:
ProductOfferingPriceAlterationOracle -
ProductOfferingPriceAllowanceOracle
Title:
ProductOfferingPriceAllowanceOracle -
ProductOfferRolloverPriceOracle
Title:
ProductOfferRolloverPriceOracle -
ProductOfferingPriceCounterOracle
Title:
ProductOfferingPriceCounterOracle -
ProductOfferingPriceOverageOracle
Title:
ProductOfferingPriceOverageOracle -
ProductOfferingPricePlanOracle
Title:
ProductOfferingPricePlanOracle -
PenaltyPriceOracle
Title:
PenaltyPriceOracle -
ProductOfferingBeatPriceOracle
Title:
ProductOfferingBeatPriceOracle
Nested Schema : ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracleMatch All
Show Source
-
object
ProductOfferingPrice
Title:
ProductOfferingPriceDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }The product offering price resource. -
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
Nested Schema : ProductOfferingPriceAlterationOracle
Title:
ProductOfferingPriceAlterationOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceAlterationOracle-allOf[1]
Nested Schema : ProductOfferingPriceAllowanceOracle
Title:
ProductOfferingPriceAllowanceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceAllowanceOracle-allOf[1]
Nested Schema : ProductOfferRolloverPriceOracle
Title:
ProductOfferRolloverPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferRolloverPriceOracle-allOf[1]
Nested Schema : ProductOfferingPriceCounterOracle
Title:
ProductOfferingPriceCounterOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceCounterOracle-allOf[1]
Nested Schema : ProductOfferingPriceOverageOracle
Title:
ProductOfferingPriceOverageOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPriceOverageOracle-allOf[1]
Nested Schema : ProductOfferingPricePlanOracle
Title:
ProductOfferingPricePlanOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingPricePlanOracle-allOf[1]
Nested Schema : PenaltyPriceOracle
Title:
PenaltyPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
PenaltyPriceOracle-allOf[1]
Nested Schema : ProductOfferingBeatPriceOracle
Title:
ProductOfferingBeatPriceOracleMatch All
Show Source
-
allOf
ProductOfferingPriceOracle
Title:
ProductOfferingPriceOracle -
object
ProductOfferingBeatPriceOracle-allOf[1]
Nested Schema : ProductOfferingPrice
Type:
objectTitle:
ProductOfferingPriceDiscriminator: @type
Discriminator Values
- ProductOfferingPrice
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferingBeatPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
The product offering price resource.
Show Source
-
@baseType: string
The base type of the product offering price.
-
@schemaLocation: string
The URI of the schema that defines the product offering price.
-
@type(required): string
The class type of the product offering price.
-
alterationBasedOn: object
AlterationBasedOnOracle
Title:
AlterationBasedOnOracleA number, unit and an expression representing the relative alteration. -
alterationExpression: array
alterationExpression
A list of alteration expressions associated with the product offering price.
-
billOnPurchase: boolean
Whether the product offering price has bill on purchase.
-
bundledPopRelationship: array
bundledPopRelationship
A list of bundled pop relationships associated with the product offering price.
-
description: string
The description of the product offering price.
-
discountable: boolean
Whether the product offering price is discountable.
-
glid: string
The general ledger ID associated with the product offering price.
-
href: string
The hyperlink reference to the product offering price.
-
id: string
Maximum Length:
30The ID of the product offering price. -
isBundle: boolean
Whether the product offering price is bundle.
-
lastUpdate: string
(date-time)
The date and time when the product offering price was last updated.
-
lifecycleStatus: string
The status of the product offering price.
-
name: string
The name of the product offering price.
-
percentage: number
The percentage to apply for ProdOfferPriceAlteration.
-
place: array
place
A list of places associated with the product offering price.
-
policy: array
policy
A list of policies associated with the product offering price.
-
popRelationship: array
popRelationship
A list of pop relationships associated with the product offering price.
-
price: object
Money
Title:
MoneyThe amount of money that characterizes the price. -
priceType: string
Allowed Values:
[ "RECURRING", "ONE_TIME", "USAGE", "ALTERATION", "ALLOWANCE", "ALLOWANCE_GRANT", "OVERAGE", "PENALTY", "ONE_TIME_PRICE_PLAN", "RECURRING_PRICE_PLAN", "USAGE_PRICE_PLAN", "ALTERATION_PRICE_PLAN", "OVERAGE_PRICE_PLAN", "COUNTER", "ROLLOVER" ]The type or classification of the product offering price. -
pricingLogicAlgorithm: array
pricingLogicAlgorithm
A list of pricing logic algorithms associated with the product offering price.
-
prodSpecCharValueUse: array
prodSpecCharValueUse
A list of prod specification characteristic value uses associated with the product offering price.
-
productOfferingTerm: array
productOfferingTerm
A list of product offering terms associated with the product offering price.
-
recurringChargePeriodLength: integer
The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1.
-
recurringChargePeriodType: string
Allowed Values:
[ "MONTHLY", "BI_MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "ANNUAL", "DAILY" ]The type or classification of the product offering price. Valid values are MONTHLY, BI_MONTHLY, QUARTERLY, SEMI_ANNUAL, ANNUAL, and DAILY. -
specCharValueUse: array
specCharValueUse
A list of spec characteristic value uses associated with the product offering price.
-
tax: array
tax
A list of taxes associated with the product offering price.
-
unitOfMeasure: object
Quantity
Title:
QuantityA number and unit representing how many of an ProductOffering is available at the offered price. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The product offering price version.
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
- ProductOfferingPriceOracle
- ProductOfferPriceAlterationOracle
- ProductOfferPriceAllowanceOracle
- ProductOfferRolloverPriceOracle
- ProductOfferingBeatPriceOracle
- ProductOfferPriceCounterOracle
- ProductOfferPriceOverageOracle
- ProductOfferPricePlanOracle
- PenaltyPriceOracle
-
alterationAppliedOn: string
Allowed Values:
[ "USER_BALANCE", "SHARER_BALANCE" ]Indicates sharing option for the alteration price. Valid values are USER_BALANCE and SHARER_BALANCE. -
applicationName: string
The name of the application associated with the product offering price.
-
balanceElement: array
balanceElement
A list of balance elements associated with the product offering price.
-
chargeType: string
Allowed Values:
[ "DEBIT", "CREDIT" ]The type or classification of the product offering price. Valid values are DEBIT, and CREDIT. -
counter: array
counter
A list of counters associated with the product offering price.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
customProfileSpec: array
customProfileSpec
A list of custom profile specifications associated with the product offering price.
-
discountMode: string
Allowed Values:
[ "SEQUENTIAL", "PARALLEL" ]Indicates the mode of processing discounts. Valid values are SEQUENTIAL and PARALLEL. -
externalId: string
The ID of the external associated with the product offering price.
-
isTaxInclusive: boolean
Whether the product offering price is tax inclusive.
-
lastUpdatedBy: string
The name of the person who updated item.
-
oneTimeFeeType: string
Allowed Values:
[ "PURCHASE", "CANCEL", "PENALTY" ]The type or classification of the product offering price. Valid values are PURCHASE, CANCEL, and PENALTY. -
pricelist: array
pricelist
A list of pricelists associated with the product offering price.
-
priceSubType: string
Allowed Values:
[ "INSTALLMENT", "LEASE", "MIN_DOWNPAYMENT", "UPGRADE_FEE", "MIGRATION_FEE", "PRICE_PLA", "DEPOSIT", "DOWNGRADE", "EARLY_TERMINATION", "PURCH_OPTION", "LEASE_TOTAL", "COMPOSITE_ALTRN", "NON_CURRENCY_ALTRN", "LEASE_DEFERRED_AMOUNT", "VALUE_INCREMENT", "VALUE_DECREMENT", "PERCENT_INCREMENT", "PERCENT_DECREMENT" ]The type or classification of the product offering price. -
priceTag: string
The priceTag for the price.
-
priceTagValueObject: object
PriceTagRefOracle
Title:
PriceTagRefOracleThe priceTag reference. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
recurringFeeType: string
Allowed Values:
[ "CYCLE", "CYCLE_ARREAR", "CYCLE_FWD_ARREAR" ]The type or classification of the product offering price. Valid values are CYCLE, CYCLE_ARREAR, and CYCLE_FWD_ARREAR. -
relativeValidFor: object
TimePeriodRelativeOracle
Title:
TimePeriodRelativeOracleThe relative validity period of the related party. -
triggerConditionGroup: array
triggerConditionGroup
A list of trigger condition groups associated with the product offering price.
-
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle -
versionState: number
The version state of the productOfferingPrice.
Nested Schema : ProductOfferingPriceAlterationOracle-allOf[1]
Type:
Show Source
object-
alterationType: string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "CHARGE_SHARE" ]The type or classification of the product offering price alteration. Valid values are DISCOUNT, MARKUP, OVERRIDE, DISCOUNT_OVERRIDE, and CHARGE_SHARE. -
discountEligibility: object
PriceEligibilityOracle
Title:
PriceEligibilityOracleSpecifies the eligibility rule for the offer. -
priority: integer
The priority of this resource represented in numerical value.
Nested Schema : PriceEligibilityOracle
Type:
objectTitle:
PriceEligibilityOracleSpecifies the eligibility rule for the offer.
Show Source
-
active: boolean
Whether the price eligibility has active.
-
description: string
A narrative text describing the eligibility rule.
-
eligibilityExpression: array
eligibilityExpression
A list of eligibility expressions associated with the price eligibility.
-
id: string
A string. Unique identifier of the pricing eligibility rule.
-
name(required): string
The name of the price eligibility.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party.
Nested Schema : eligibilityExpression
Type:
arrayA list of eligibility expressions associated with the price eligibility.
Show Source
-
Array of:
object EligibilityExpressionOracle
Title:
EligibilityExpressionOracleThe eligibility expression resource.
Nested Schema : TimePeriodOracle
Type:
objectTitle:
TimePeriodOracleThe validity period of the related party.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : EligibilityExpressionOracle
Type:
objectTitle:
EligibilityExpressionOracleThe eligibility expression resource.
Show Source
-
@baseType: string
The base type of the eligibility expression.
-
@schemaLocation: string
The URI of the schema that defines the eligibility expression.
-
@type(required): string
The class type of the eligibility expression.
-
expressionRelationship: array
expressionRelationship
A list of expression relationships associated with the eligibility expression.
-
expressionType(required): string
Allowed Values:
[ "ARITHMATIC", "NUMERIC", "LOGICAL", "CHARGE", "QUANTITY", "BALANCE" ]The type or classification of the eligibility expression. Valid values are ARITHMATIC, NUMERIC, LOGICAL, CHARGE, QUANTITY, and BALANCE. -
id(required): string
The ID of the eligibility expression.
-
operator: string
The operator of the expression.
-
value:
value
A discrete value that the relationship can take on.
Nested Schema : expressionRelationship
Type:
arrayA list of expression relationships associated with the eligibility expression.
Show Source
-
Array of:
object ExpressionRelationship
Title:
ExpressionRelationshipThe expression relationship resource.
Nested Schema : value
A discrete value that the relationship can take on.
Match One Schema
Show Source
Nested Schema : ExpressionRelationship
Type:
objectTitle:
ExpressionRelationshipThe expression relationship resource.
Show Source
-
@baseType: string
The base type of the expression relationship.
-
@schemaLocation: string
The URI of the schema that defines the expression relationship.
-
@type(required): string
The class type of the expression relationship.
-
expressionId(required): string
The ID of the expression associated with the expression relationship.
-
href: string
The hyperlink reference to the expression relationship.
-
name: string
The name of the expression relationship.
-
relationshipType(required): string
Allowed Values:
[ "LEFT_HAND_SIDE", "RIGHT_HAND_SIDE" ]The type or classification of the expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.
Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]
Type:
Show Source
object-
allowanceValidity: object
AllowanceValidityOracle
Title:
AllowanceValidityOracleThe validity of allowance. -
ruleName: string
Maximum Length:
50The name of the rule associated with the product offering price allowance. -
rulePriority: number
Indicates the priority of the rule associated.
- shareAllowance: boolean
-
usageUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]Indicates the usage unit.
Nested Schema : AllowanceValidityOracle
Type:
objectTitle:
AllowanceValidityOracleThe validity of allowance.
Show Source
-
startCriteria: string
Allowed Values:
[ "EVENT_OCCURRENCE", "FIRST_USAGE" ]Indicates start criteria of allowance validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE. -
unit(required): string
Allowed Values:
[ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]Indicates the unit of allowance validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE. -
value(required): number
The value assigned to the product offering price allowance.
Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]
Type:
Show Source
object-
rolloverFrequency: string
Allowed Values:
[ "MONTH" ]The period to repeat the rollover for. Valid values are MONTH. -
rolloverRules: array
rolloverRules
A list of rollover rules associated with the product offer rollover price.
Nested Schema : rolloverRules
Type:
arrayA list of rollover rules associated with the product offer rollover price.
Show Source
-
Array of:
object RolloverRuleOracle
Title:
RolloverRuleOracleThe rollover rule resource.
Nested Schema : RolloverRuleOracle
Type:
objectTitle:
RolloverRuleOracleThe rollover rule resource.
Show Source
-
balanceElement: object
BalanceElementRef
Title:
BalanceElementRefThe balance element ref in price. -
balanceElementCode(required): string
Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency.
-
glid: string
The gLID for the rollover charge.
-
id(required): string
Maximum Length:
30The ID of the rollover rule. -
maxCumulativeRolloverAmount: number
The maximum rollover amount that can be accumulated.
-
maximumRolloverCycles: object
MaximumRolloverCycleOracle
Title:
MaximumRolloverCycleOracleIndicates the maximum allowed rollover cycles and the unit. -
maxRolloverAmountPerCycle: number
The maximum amount that can be rolled over in a cycle.
-
unitOfMeasure: string
The unit of measure for which the priceTag rule applies to.
Nested Schema : BalanceElementRef
Type:
objectTitle:
BalanceElementRefThe balance element ref in price.
Show Source
-
@baseType: string
The base type of the balance element reference.
-
@referredType(required): string
The type of the referred balance element reference.
-
@schemaLocation: string
The URI of the schema that defines the balance element reference.
-
@type(required): string
The class type of the balance element reference.
-
href: string
The hyperlink reference to the balance element reference.
-
id(required): string
The ID of the balance element reference.
-
name: string
The name of the balance element reference.
-
version: string
The version of the balance element.
-
versionState: number
The version state of the reference.
Nested Schema : MaximumRolloverCycleOracle
Type:
objectTitle:
MaximumRolloverCycleOracleIndicates the maximum allowed rollover cycles and the unit.
Show Source
-
unit(required): string
Allowed Values:
[ "DAYS", "WEEKS", "MONTHS", "YEARS" ]Indicates the unit of rollover cycle. Valid values are DAYS, WEEKS, MONTHS, and YEARS. -
value(required): number
The value assigned to the rollover rule.
Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]
Type:
Show Source
object-
counterValidity: object
CounterValidityOracle
Title:
CounterValidityOracleThe validity of counter.
Nested Schema : CounterValidityOracle
Type:
objectTitle:
CounterValidityOracleThe validity of counter.
Show Source
-
startCriteria: string
Allowed Values:
[ "EVENT_OCCURRENCE", "FIRST_USAGE" ]Indicates start criteria of counter validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE. -
unit(required): string
Allowed Values:
[ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]Indicates the unit of counter validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE. -
value(required): number
The value assigned to the product offering price counter.
Nested Schema : ProductOfferingPriceOverageOracle-allOf[1]
Type:
objectNested Schema : ProductOfferingPricePlanOracle-allOf[1]
Type:
Show Source
object-
alterationType: string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE" ]The type or classification of the product offering price plan. Valid values are DISCOUNT, MARKUP, OVERRIDE, and DISCOUNT_OVERRIDE. -
compositePopRelationship: array
compositePopRelationship
A list of composite pop relationships associated with the product offering price plan.
-
priceRange: string
Indicates the range of prices this price plan defines.
-
ruleName: string
Maximum Length:
50The name of the rule associated with the product offering price plan. -
rulePriority: number
Indicates the priority of the rule associated.
-
usageSpecMeteringRuleUse: array
usageSpecMeteringRuleUse
A list of usage specification metering rule uses associated with the product offering price plan.
Nested Schema : compositePopRelationship
Type:
arrayA list of composite pop relationships associated with the product offering price plan.
Show Source
-
Array of:
object CompositePopRelationshipOracle
Title:
CompositePopRelationshipOracleThe composite relationship from a parent product offering price to a child product offering price.
Nested Schema : usageSpecMeteringRuleUse
Type:
arrayA list of usage specification metering rule uses associated with the product offering price plan.
Show Source
-
Array of:
object UsageSpecMeteringRuleUse
Title:
UsageSpecMeteringRuleUseThe metering rules used in the usage price plan.
Nested Schema : CompositePopRelationshipOracle
Type:
objectTitle:
CompositePopRelationshipOracleThe composite relationship from a parent product offering price to a child product offering price.
Show Source
-
@baseType: string
The base type of the composite pop relationship.
-
@referredType(required): string
A string. The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
The URI of the schema that defines the composite pop relationship.
-
@type(required): string
The class type of the composite pop relationship.
-
href: string
The hyperlink reference to the composite pop relationship.
-
id(required): string
The ID of the composite pop relationship.
-
name: string
The name of the composite pop relationship.
-
relationshipType: string
Allowed Values:
[ "COMPOSITE" ]The type or classification of the composite pop relationship. Valid values are COMPOSITE. -
version: string
The version of the associated product offering price.
Nested Schema : UsageSpecMeteringRuleUse
Type:
objectTitle:
UsageSpecMeteringRuleUseThe metering rules used in the usage price plan.
Show Source
-
id(required): string
The ID of the usage specification metering rule use.
-
name(required): string
The name of the usage specification metering rule use.
-
usageSpecification(required):
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracleMatch All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
object
UsageSpecificationRefOracle-allOf[1]
Nested Schema : UsageSpecificationRef
Type:
objectTitle:
UsageSpecificationRefDiscriminator: @type
Discriminator Values
The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
The base type of the usage specification reference.
-
@referredType(required): string
The type of the referred usage specification reference.
-
@schemaLocation: string
The URI of the schema that defines the usage specification reference.
-
@type(required): string
The class type of the usage specification reference.
-
href: string
The hyperlink reference to the usage specification reference.
-
id(required): string
The ID of the usage specification reference.
-
name: string
The name of the usage specification reference.
-
version: string
The version of the usage specification.
-
versionState: number
The version state of the reference.
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
usageCode: string
The usage code associated with the usage specification reference.
Nested Schema : PenaltyPriceOracle-allOf[1]
Type:
Show Source
object-
prorationReductionTerm: array
prorationReductionTerm
A list of proration reduction terms associated with the penalty price.
Nested Schema : prorationReductionTerm
Type:
arrayA list of proration reduction terms associated with the penalty price.
Show Source
-
Array of:
object ProrationReductionTerm
Title:
ProrationReductionTermProvides references to Early Termination Fee (ETF) that prorates the ETF for a subscriber based on their contract duration. This proration allows a subscriber to pay less to terminate as more time passes giving them an option to stay on for an additional period in contract to minimize their exit fee.
Nested Schema : ProrationReductionTerm
Type:
objectTitle:
ProrationReductionTermProvides references to Early Termination Fee (ETF) that prorates the ETF for a subscriber based on their contract duration. This proration allows a subscriber to pay less to terminate as more time passes giving them an option to stay on for an additional period in contract to minimize their exit fee.
Show Source
-
durationUnits: string
Allowed Values:
[ "DAYS", "MONTHS", "WEEKS", "YEARS" ]The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS. -
fromOffset: number
The start of the schedule.
-
reductionPercentage: number
The percentage of the amount to be deducted.
Nested Schema : ProductOfferingBeatPriceOracle-allOf[1]
Type:
Show Source
object-
beat: object
BeatOracle
Title:
BeatOracleThe beat is basically the pulse measure used for charging usage quantity.
Nested Schema : BeatOracle
Type:
objectTitle:
BeatOracleThe beat is basically the pulse measure used for charging usage quantity.
Show Source
-
incrementQuantity: number
The usage quantity increment of the beat.
-
incrementQuantityUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit of measure for the incrementQuantity of beat. -
minQuantity: number
The minimum usage quantity of the beat.
-
minQuantityUnit: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit of measure for the minQuantity of beat. -
roundingMode: string
Allowed Values:
[ "DOWN", "DOWN_ALT", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]The rounding strategy applied to beat usage quantities. Valid values are DOWN, DOWN_ALT, FLOOR, FLOOR_ALT, NEAREST, and UP.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to update a product offering price by submitting a Patch request on the REST resource using cURL.
cURL Command
curl -u username:password -X PATCH
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/LeatherPurseOTCPrice
-H 'Content-Type: application/json' -D @update_productofferingprice.json |
json_pp
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"description" : "Price for $12.99",
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
}
}Example of Response Body
The following example shows the contents of the response body in JSON
format.
{
"id": "POP-HS-OTF1",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/POP-HS-OTF1",
"name": "Hotspot One Time Fee",
"description" : "Price for $12.99",
"version": "1.0",
"priceType": "ONE_TIME_PRICE_PLAN",
"@type": "ProductOfferPricePlanOracle",
"@baseType": "ProductOfferingPriceOracle",
"@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferPricePlanOracle.yml",
"isBundle": false,
"lastUpdate": "2025-02-17T12:28:20.045Z",
"lifecycleStatus": "In design",
"lastUpdatedBy": "booth",
"created": "2025-02-17T12:28:20.000Z",
"createdBy": "booth",
"versionState": 0,
"isTaxInclusive": false,
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
}
"project": {
"id": "DBE_RI_Mob_ProdModel_PSP",
"name": "DBE RI Mobile Product Model",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"price": {
"value": 12.99,
"unit": "USD"
},
"oneTimeFeeType": "PURCHASE",
"pricelist": [
{
"id": "DBE_NA_PL",
"name": "DBE NA Pricelist",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_NA_PL",
"version": "1.0",
"versionState": -1,
"@referredType": "PricelistOracle",
"@type": "PriceListGroupRefOracle",
"@baseType": "PricelistOracle"
}
]
}