Jump to

• Request
• Response
• Examples

Update a product offering price

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/{id}

Request

Path Parameters

• id(required): string
  The unique identifier of the resource item.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ProductOfferingPrice_Schemas

Type: object

Title: ProductOfferingPrice_Schemas

Discriminator: @type

Discriminator Values

• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "title":"ProductOfferingPrice_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
        },
        {
            "$ref":"#/components/schemas/PenaltyPriceOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Match One Schema

Show Source

• ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• ProductOfferingPriceAlterationOracle
  Title: ProductOfferingPriceAlterationOracle
• ProductOfferingPriceCounterOracle
  Title: ProductOfferingPriceCounterOracle
• ProductOfferingPriceAllowanceOracle
  Title: ProductOfferingPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
  Title: ProductOfferRolloverPriceOracle
• ProductOfferingPriceOverageOracle
  Title: ProductOfferingPriceOverageOracle
• ProductOfferingPricePlanOracle
  Title: ProductOfferingPricePlanOracle
• PenaltyPriceOracle
  Title: PenaltyPriceOracle

{
    "title":"ProductOfferingPrice_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
        },
        {
            "$ref":"#/components/schemas/PenaltyPriceOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : ProductOfferingPriceOracle

Title: ProductOfferingPriceOracle

Match All

Show Source

• object ProductOfferingPrice
  Title: ProductOfferingPrice

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }

{
    "title":"ProductOfferingPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPrice"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "isTaxInclusive":{
                    "type":"boolean",
                    "description":"Indicates id the price is inclusive of tax"
                },
                "priceSubType":{
                    "type":"string",
                    "description":"tag of the price like Overage, Allowance, Installment  etc.",
                    "enum":[
                        "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"
                    ]
                },
                "priceTag":{
                    "type":"string",
                    "description":"PriceTag for the price."
                },
                "oneTimeFeeType":{
                    "type":"string",
                    "description":"Indicates the one time fee type. The default value is PURCHASE.",
                    "enum":[
                        "PURCHASE",
                        "CANCEL",
                        "PENALTY"
                    ]
                },
                "recurringFeeType":{
                    "type":"string",
                    "description":"Indicates the recurring fee type. The default value is CYCLE.",
                    "enum":[
                        "CYCLE",
                        "CYCLE_ARREAR",
                        "CYCLE_FWD_ARREAR"
                    ]
                },
                "priceTagValueObject":{
                    "$ref":"#/components/schemas/PriceTagRefOracle"
                },
                "pricelist":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceListRefOracle"
                    }
                },
                "customProfileSpec":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
                    }
                },
                "usageSpecification":{
                    "$ref":"#/components/schemas/UsageSpecificationRefOracle"
                },
                "balanceElement":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/BalanceElementRef"
                    }
                },
                "relativeValidFor":{
                    "$ref":"#/components/schemas/TimePeriodRelativeOracle"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the productOfferingPrice"
                },
                "triggerConditionGroup":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TriggerConditionGroupOracle"
                    }
                },
                "counter":{
                    "type":"array",
                    "items":{
                        "anyOf":[
                            {
                                "$ref":"#/components/schemas/ProductOfferingPriceRef"
                            },
                            {
                                "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                            }
                        ],
                        "discriminator":{
                            "propertyName":"@type",
                            "mapping":{
                                "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                                "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                            }
                        }
                    }
                },
                "alterationAppliedOn":{
                    "type":"string",
                    "description":"indicates sharing option for the alteration price",
                    "enum":[
                        "USER_BALANCE",
                        "SHARER_BALANCE"
                    ]
                },
                "discountMode":{
                    "type":"string",
                    "description":"Indicates the mode of processing discounts.",
                    "enum":[
                        "SEQUENTIAL",
                        "PARALLEL"
                    ]
                },
                "chargeType":{
                    "type":"string",
                    "description":"Indicates the charge type for the alteration.",
                    "enum":[
                        "DEBIT",
                        "CREDIT"
                    ]
                }
            },
            "discriminator":{
                "propertyName":"@type",
                "mapping":{
                    "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
                    "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
                    "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
                    "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
                    "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
                    "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
                    "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
                    "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceAlterationOracle

Title: ProductOfferingPriceAlterationOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceAlterationOracle-allOf[1]

{
    "title":"ProductOfferingPriceAlterationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "priority":{
                    "type":"integer",
                    "description":"Priority of this resource represented in numerical value."
                },
                "discountEligibility":{
                    "$ref":"#/components/schemas/PriceEligibilityOracle"
                },
                "alterationType":{
                    "type":"string",
                    "description":"Describe the alteration price",
                    "enum":[
                        "DISCOUNT",
                        "MARKUP",
                        "OVERRIDE",
                        "DISCOUNT_OVERRIDE",
                        "CHARGE_SHARE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceCounterOracle

Title: ProductOfferingPriceCounterOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceCounterOracle-allOf[1]

{
    "title":"ProductOfferingPriceCounterOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "counterValidity":{
                    "title":"CounterValidityOracle",
                    "type":"object",
                    "description":"Validity of counter",
                    "properties":{
                        "value":{
                            "type":"number",
                            "description":"Indicates the value of counter validity"
                        },
                        "unit":{
                            "type":"string",
                            "description":"Indicates the unit of counter validity",
                            "enum":[
                                "SECOND",
                                "MINUTE",
                                "HOUR",
                                "DAY",
                                "MONTH",
                                "ACCOUNTING_CYCLE",
                                "BILLING_CYCLE"
                            ]
                        },
                        "startCriteria":{
                            "type":"string",
                            "description":"Indicates start criteria of counter validity.",
                            "enum":[
                                "EVENT_OCCURRENCE",
                                "FIRST_USAGE"
                            ]
                        }
                    },
                    "required":[
                        "value",
                        "unit"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceAllowanceOracle

Title: ProductOfferingPriceAllowanceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceAllowanceOracle-allOf[1]

{
    "title":"ProductOfferingPriceAllowanceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "shareAllowance":{
                    "type":"boolean",
                    "description":"Flag to indicate that the allowance is shared"
                },
                "usageUnit":{
                    "type":"string",
                    "description":"Indicates the usage unit",
                    "enum":[
                        "NONE",
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "BYTE",
                        "KILOBYTE",
                        "MEGABYTE",
                        "GIGABYTE",
                        "PAGES",
                        "MOVIES",
                        "TIME_INTERVAL",
                        "QUANTITY",
                        "MBPS",
                        "GBPS"
                    ]
                },
                "allowanceValidity":{
                    "title":"AllowanceValidityOracle",
                    "type":"object",
                    "description":"Validity of allowance",
                    "properties":{
                        "value":{
                            "type":"number",
                            "description":"Indicates the amount of allowance validity"
                        },
                        "unit":{
                            "type":"string",
                            "description":"Indicates the unit of allowance validity",
                            "enum":[
                                "SECOND",
                                "MINUTE",
                                "HOUR",
                                "DAY",
                                "MONTH",
                                "ACCOUNTING_CYCLE",
                                "BILLING_CYCLE"
                            ]
                        },
                        "startCriteria":{
                            "type":"string",
                            "description":"Indicates start criteria of allowance validity.",
                            "enum":[
                                "EVENT_OCCURRENCE",
                                "FIRST_USAGE"
                            ]
                        }
                    },
                    "required":[
                        "value",
                        "unit"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferRolloverPriceOracle

Title: ProductOfferRolloverPriceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferRolloverPriceOracle-allOf[1]

{
    "title":"ProductOfferRolloverPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "rolloverFrequency":{
                    "type":"string",
                    "description":"The period to repeat the rollover for.",
                    "enum":[
                        "MONTH"
                    ]
                },
                "rolloverRules":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RolloverRuleOracle"
                    }
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceOverageOracle

Title: ProductOfferingPriceOverageOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceOverageOracle-allOf[1]

{
    "title":"ProductOfferingPriceOverageOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ProductOfferingPricePlanOracle

Title: ProductOfferingPricePlanOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPricePlanOracle-allOf[1]

{
    "title":"ProductOfferingPricePlanOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "alterationType":{
                    "type":"string",
                    "description":"Describe the alteration price",
                    "enum":[
                        "DISCOUNT",
                        "MARKUP",
                        "OVERRIDE",
                        "DISCOUNT_OVERRIDE"
                    ]
                },
                "priceRange":{
                    "type":"string",
                    "description":"Indicates the range of prices this price plan defines"
                },
                "compositePopRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CompositePopRelationshipOracle"
                    }
                },
                "usageSpecMeteringRuleUse":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
                    }
                }
            }
        }
    ]
}

Nested Schema : PenaltyPriceOracle

Title: PenaltyPriceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object PenaltyPriceOracle-allOf[1]

{
    "title":"PenaltyPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "prorationReductionTerm":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProrationReductionTermOracle"
                    }
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPrice

Type: object

Title: ProductOfferingPrice

Discriminator: @type

Discriminator Values

• ProductOfferingPrice
• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "title":"ProductOfferingPrice",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the productOfferingPrice"
        },
        "description":{
            "type":"string",
            "description":"Description of the productOfferingPrice"
        },
        "version":{
            "type":"string",
            "description":"ProductOfferingPrice version"
        },
        "glid":{
            "type":"string",
            "description":"glid"
        },
        "discountable":{
            "type":"boolean",
            "description":"A flag indicating if this POP is discountable or not"
        },
        "billOnPurchase":{
            "type":"boolean",
            "description":"A flag indicating if a bill on purchase is to be provided or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "unitOfMeasure":{
            "$ref":"#/components/schemas/Quantity"
        },
        "recurringChargePeriodType":{
            "type":"string",
            "description":"The period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.",
            "enum":[
                "MONTHLY",
                "BI_MONTHLY",
                "QUARTERLY",
                "SEMI_ANNUAL",
                "ANNUAL",
                "DAILY"
            ]
        },
        "recurringChargePeriodLength":{
            "type":"integer",
            "description":"The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering price"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering price"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicating if this POP is composite (bundle) or not"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "price":{
            "$ref":"#/components/schemas/Money"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage to apply for ProdOfferPriceAlteration"
        },
        "bundledPopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOfferingPriceRelationship"
            }
        },
        "popRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRelationship"
            }
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            }
        },
        "specCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SpecCharValueUse"
            }
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/CommitmentTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/SubscriptionTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/PaymentTermOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
                        "ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
                        "CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
                        "SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
                        "PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
                    }
                }
            }
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PolicyRef"
            }
        },
        "pricingLogicAlgorithm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PricingLogicAlgorithmRef"
            }
        },
        "tax":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "alterationBasedOn":{
            "$ref":"#/components/schemas/AlterationBasedOnOracle"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Show Source

• @baseType: string
  Immediate base (class) type of the product offering price
• @schemaLocation: string
  A link to the schema describing this product offering price
• @type(required): string
  Class type of the product offering price
• alterationBasedOn: object AlterationBasedOnOracle
  Title: AlterationBasedOnOracle

  A number, unit and an expression representing the relative alteration.
• billOnPurchase: boolean
  A flag indicating if a bill on purchase is to be provided or not
• bundledPopRelationship: array bundledPopRelationship
• description: string
  Description of the productOfferingPrice
• discountable: boolean
  A flag indicating if this POP is discountable or not
• glid: string
  glid
• href: string
  Hyperlink reference of this resource
• id: string
  Maximum Length: 30

  Unique id of this resource
• isBundle: boolean
  A flag indicating if this POP is composite (bundle) or not
• lastUpdate: string (date-time)
  Date and time of the last update
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name: string
  Name of the productOfferingPrice
• percentage: number
  Percentage to apply for ProdOfferPriceAlteration
• place: array place
• policy: array policy
• popRelationship: array popRelationship
• price: object Money
  Title: Money

  The 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" ]

  Describes the price, such as recurring, discount, allowance, penalty, and so forth
• pricingLogicAlgorithm: array pricingLogicAlgorithm
• prodSpecCharValueUse: array prodSpecCharValueUse
• productOfferingTerm: array productOfferingTerm
• 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 period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.
• specCharValueUse: array specCharValueUse
• tax: array tax
• unitOfMeasure: object Quantity
  Title: Quantity

  A number and unit representing how many of an ProductOffering is available at the offered price.
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  ProductOfferingPrice version

{
    "title":"ProductOfferingPrice",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the productOfferingPrice"
        },
        "description":{
            "type":"string",
            "description":"Description of the productOfferingPrice"
        },
        "version":{
            "type":"string",
            "description":"ProductOfferingPrice version"
        },
        "glid":{
            "type":"string",
            "description":"glid"
        },
        "discountable":{
            "type":"boolean",
            "description":"A flag indicating if this POP is discountable or not"
        },
        "billOnPurchase":{
            "type":"boolean",
            "description":"A flag indicating if a bill on purchase is to be provided or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "unitOfMeasure":{
            "$ref":"#/components/schemas/Quantity"
        },
        "recurringChargePeriodType":{
            "type":"string",
            "description":"The period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.",
            "enum":[
                "MONTHLY",
                "BI_MONTHLY",
                "QUARTERLY",
                "SEMI_ANNUAL",
                "ANNUAL",
                "DAILY"
            ]
        },
        "recurringChargePeriodLength":{
            "type":"integer",
            "description":"The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering price"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering price"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicating if this POP is composite (bundle) or not"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "price":{
            "$ref":"#/components/schemas/Money"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage to apply for ProdOfferPriceAlteration"
        },
        "bundledPopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOfferingPriceRelationship"
            }
        },
        "popRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRelationship"
            }
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            }
        },
        "specCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SpecCharValueUse"
            }
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/CommitmentTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/SubscriptionTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/PaymentTermOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
                        "ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
                        "CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
                        "SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
                        "PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
                    }
                }
            }
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PolicyRef"
            }
        },
        "pricingLogicAlgorithm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PricingLogicAlgorithmRef"
            }
        },
        "tax":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "alterationBasedOn":{
            "$ref":"#/components/schemas/AlterationBasedOnOracle"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "isTaxInclusive":{
            "type":"boolean",
            "description":"Indicates id the price is inclusive of tax"
        },
        "priceSubType":{
            "type":"string",
            "description":"tag of the price like Overage, Allowance, Installment  etc.",
            "enum":[
                "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"
            ]
        },
        "priceTag":{
            "type":"string",
            "description":"PriceTag for the price."
        },
        "oneTimeFeeType":{
            "type":"string",
            "description":"Indicates the one time fee type. The default value is PURCHASE.",
            "enum":[
                "PURCHASE",
                "CANCEL",
                "PENALTY"
            ]
        },
        "recurringFeeType":{
            "type":"string",
            "description":"Indicates the recurring fee type. The default value is CYCLE.",
            "enum":[
                "CYCLE",
                "CYCLE_ARREAR",
                "CYCLE_FWD_ARREAR"
            ]
        },
        "priceTagValueObject":{
            "$ref":"#/components/schemas/PriceTagRefOracle"
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        },
        "balanceElement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceElementRef"
            }
        },
        "relativeValidFor":{
            "$ref":"#/components/schemas/TimePeriodRelativeOracle"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the productOfferingPrice"
        },
        "triggerConditionGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TriggerConditionGroupOracle"
            }
        },
        "counter":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceRef"
                    },
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                        "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                }
            }
        },
        "alterationAppliedOn":{
            "type":"string",
            "description":"indicates sharing option for the alteration price",
            "enum":[
                "USER_BALANCE",
                "SHARER_BALANCE"
            ]
        },
        "discountMode":{
            "type":"string",
            "description":"Indicates the mode of processing discounts.",
            "enum":[
                "SEQUENTIAL",
                "PARALLEL"
            ]
        },
        "chargeType":{
            "type":"string",
            "description":"Indicates the charge type for the alteration.",
            "enum":[
                "DEBIT",
                "CREDIT"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Show Source

• alterationAppliedOn: string
  Allowed Values: [ "USER_BALANCE", "SHARER_BALANCE" ]

  indicates sharing option for the alteration price
• applicationName: string
  name of the external application
• balanceElement: array balanceElement
• chargeType: string
  Allowed Values: [ "DEBIT", "CREDIT" ]

  Indicates the charge type for the alteration.
• counter: array counter
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• customProfileSpec: array customProfileSpec
• discountMode: string
  Allowed Values: [ "SEQUENTIAL", "PARALLEL" ]

  Indicates the mode of processing discounts.
• externalId: string
  id of the external application
• isTaxInclusive: boolean
  Indicates id the price is inclusive of tax
• lastUpdatedBy: string
  name of the person who updated item
• oneTimeFeeType: string
  Allowed Values: [ "PURCHASE", "CANCEL", "PENALTY" ]

  Indicates the one time fee type. The default value is PURCHASE.
• pricelist: array pricelist
• 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" ]

  tag of the price like Overage, Allowance, Installment etc.
• priceTag: string
  PriceTag for the price.
• priceTagValueObject: object PriceTagRefOracle
  Title: PriceTagRefOracle

  PriceTag reference.
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• recurringFeeType: string
  Allowed Values: [ "CYCLE", "CYCLE_ARREAR", "CYCLE_FWD_ARREAR" ]

  Indicates the recurring fee type. The default value is CYCLE.
• relativeValidFor: object TimePeriodRelativeOracle
  Title: TimePeriodRelativeOracle

  Relative validity period of the related party
• triggerConditionGroup: array triggerConditionGroup
• usageSpecification: UsageSpecificationRefOracle
  Title: UsageSpecificationRefOracle
• versionState: number
  Version state of the productOfferingPrice

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "isTaxInclusive":{
            "type":"boolean",
            "description":"Indicates id the price is inclusive of tax"
        },
        "priceSubType":{
            "type":"string",
            "description":"tag of the price like Overage, Allowance, Installment  etc.",
            "enum":[
                "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"
            ]
        },
        "priceTag":{
            "type":"string",
            "description":"PriceTag for the price."
        },
        "oneTimeFeeType":{
            "type":"string",
            "description":"Indicates the one time fee type. The default value is PURCHASE.",
            "enum":[
                "PURCHASE",
                "CANCEL",
                "PENALTY"
            ]
        },
        "recurringFeeType":{
            "type":"string",
            "description":"Indicates the recurring fee type. The default value is CYCLE.",
            "enum":[
                "CYCLE",
                "CYCLE_ARREAR",
                "CYCLE_FWD_ARREAR"
            ]
        },
        "priceTagValueObject":{
            "$ref":"#/components/schemas/PriceTagRefOracle"
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        },
        "balanceElement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceElementRef"
            }
        },
        "relativeValidFor":{
            "$ref":"#/components/schemas/TimePeriodRelativeOracle"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the productOfferingPrice"
        },
        "triggerConditionGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TriggerConditionGroupOracle"
            }
        },
        "counter":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceRef"
                    },
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                        "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                }
            }
        },
        "alterationAppliedOn":{
            "type":"string",
            "description":"indicates sharing option for the alteration price",
            "enum":[
                "USER_BALANCE",
                "SHARER_BALANCE"
            ]
        },
        "discountMode":{
            "type":"string",
            "description":"Indicates the mode of processing discounts.",
            "enum":[
                "SEQUENTIAL",
                "PARALLEL"
            ]
        },
        "chargeType":{
            "type":"string",
            "description":"Indicates the charge type for the alteration.",
            "enum":[
                "DEBIT",
                "CREDIT"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : ProductOfferingPriceAlterationOracle-allOf[1]

Type: object

Show Source

• alterationType: string
  Allowed Values: [ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "CHARGE_SHARE" ]

  Describe the alteration price
• discountEligibility: object PriceEligibilityOracle
  Title: PriceEligibilityOracle

  specifies the eligibility rule for the offer
• priority: integer
  Priority of this resource represented in numerical value.

{
    "type":"object",
    "properties":{
        "priority":{
            "type":"integer",
            "description":"Priority of this resource represented in numerical value."
        },
        "discountEligibility":{
            "$ref":"#/components/schemas/PriceEligibilityOracle"
        },
        "alterationType":{
            "type":"string",
            "description":"Describe the alteration price",
            "enum":[
                "DISCOUNT",
                "MARKUP",
                "OVERRIDE",
                "DISCOUNT_OVERRIDE",
                "CHARGE_SHARE"
            ]
        }
    }
}

Nested Schema : PriceEligibilityOracle

Type: object

Title: PriceEligibilityOracle

specifies the eligibility rule for the offer

Show Source

• active: boolean
  A flag indicating if the rule is active or not
• description: string
  A narrative text describing the eligibility rule
• eligibilityExpression: array eligibilityExpression
• id: string
  A string. Unique identifier of the pricing eligibility rule.
• name(required): string
  Name of the eligibility rule
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"PriceEligibilityOracle",
    "type":"object",
    "description":"specifies the eligibility rule for the offer",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the pricing eligibility rule."
        },
        "name":{
            "type":"string",
            "description":"Name of the eligibility rule"
        },
        "description":{
            "type":"string",
            "description":"A narrative text describing the eligibility rule"
        },
        "eligibilityExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EligibilityExpressionOracle"
            }
        },
        "active":{
            "type":"boolean",
            "description":"A flag indicating if the rule is active or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : eligibilityExpression

Type: array

Show Source

• Array of: object EligibilityExpressionOracle
  Title: EligibilityExpressionOracle

  A eligibility expression

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EligibilityExpressionOracle"
    }
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : EligibilityExpressionOracle

Type: object

Title: EligibilityExpressionOracle

A eligibility expression

Show Source

• @baseType: string
  The immediate base class type of the Elibility Expression
• @schemaLocation: string
  A link to the schema describing this Elibility Expression entity
• @type(required): string
  the class type of the Elibility Expression
• expressionRelationship: array expressionRelationship
• expressionType(required): string
  Allowed Values: [ "ARITHMATIC", "NUMERIC", "LOGICAL", "CHARGE", "QUANTITY", "BALANCE" ]

  Expression Type of the expression
• id(required): string
  A string. Unique identifier of the eligibility expression.
• operator: string
  Operator of the expression
• value: value
  A discrete value that the relationship can take on.

{
    "type":"object",
    "title":"EligibilityExpressionOracle",
    "description":"A eligibility expression",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the eligibility expression."
        },
        "operator":{
            "type":"string",
            "description":"Operator of the expression"
        },
        "expressionType":{
            "type":"string",
            "description":"Expression Type of the expression",
            "enum":[
                "ARITHMATIC",
                "NUMERIC",
                "LOGICAL",
                "CHARGE",
                "QUANTITY",
                "BALANCE"
            ]
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ],
            "description":"A discrete value that the relationship can take on."
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Elibility Expression"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Elibility Expression"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Elibility Expression entity"
        },
        "expressionRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExpressionRelationship"
            }
        }
    },
    "required":[
        "expressionType",
        "id",
        "@type"
    ]
}

Nested Schema : expressionRelationship

Type: array

Show Source

• Array of: object ExpressionRelationship
  Title: ExpressionRelationship

  An expression relationship

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExpressionRelationship"
    }
}

Nested Schema : value

A discrete value that the relationship can take on.

Match One Schema

Show Source

• string
• number
• boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ],
    "description":"A discrete value that the relationship can take on."
}

Nested Schema : ExpressionRelationship

Type: object

Title: ExpressionRelationship

An expression relationship

Show Source

• @baseType: string
  The immediate base class type of the Eligibity Expression Relationship
• @schemaLocation: string
  A link to the schema describing this Eligibity Expression Relationship entity
• @type(required): string
  the class type of the Eligibity Expression Relationship
• expressionId(required): string
  A string. The unique id given for the expression relationship
• href: string
  A string. The href given for the expression relationship
• name: string
  A string. The name given for the expression relationship
• relationshipType(required): string
  Allowed Values: [ "LEFT_HAND_SIDE", "RIGHT_HAND_SIDE" ]

  A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.

{
    "type":"object",
    "title":"ExpressionRelationship",
    "description":"An expression relationship",
    "properties":{
        "expressionId":{
            "type":"string",
            "description":"A string. The unique id given for the expression relationship"
        },
        "name":{
            "type":"string",
            "description":"A string. The name given for the expression relationship"
        },
        "href":{
            "type":"string",
            "description":"A string. The href given for the expression relationship"
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.",
            "enum":[
                "LEFT_HAND_SIDE",
                "RIGHT_HAND_SIDE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Eligibity Expression Relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Eligibity Expression Relationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Eligibity Expression Relationship entity"
        }
    },
    "required":[
        "relationshipType",
        "expressionId",
        "@type"
    ]
}

Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]

Type: object

Show Source

• counterValidity: object CounterValidityOracle
  Title: CounterValidityOracle

  Validity of counter

{
    "type":"object",
    "properties":{
        "counterValidity":{
            "title":"CounterValidityOracle",
            "type":"object",
            "description":"Validity of counter",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the value of counter validity"
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of counter validity",
                    "enum":[
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "ACCOUNTING_CYCLE",
                        "BILLING_CYCLE"
                    ]
                },
                "startCriteria":{
                    "type":"string",
                    "description":"Indicates start criteria of counter validity.",
                    "enum":[
                        "EVENT_OCCURRENCE",
                        "FIRST_USAGE"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        }
    }
}

Nested Schema : CounterValidityOracle

Type: object

Title: CounterValidityOracle

Validity of counter

Show Source

• startCriteria: string
  Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]

  Indicates start criteria of counter validity.
• unit(required): string
  Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]

  Indicates the unit of counter validity
• value(required): number
  Indicates the value of counter validity

{
    "title":"CounterValidityOracle",
    "type":"object",
    "description":"Validity of counter",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the value of counter validity"
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of counter validity",
            "enum":[
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "ACCOUNTING_CYCLE",
                "BILLING_CYCLE"
            ]
        },
        "startCriteria":{
            "type":"string",
            "description":"Indicates start criteria of counter validity.",
            "enum":[
                "EVENT_OCCURRENCE",
                "FIRST_USAGE"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]

Type: object

Show Source

• allowanceValidity: object AllowanceValidityOracle
  Title: AllowanceValidityOracle

  Validity of allowance
• shareAllowance: boolean
  Flag to indicate that the allowance is shared
• 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

{
    "type":"object",
    "properties":{
        "shareAllowance":{
            "type":"boolean",
            "description":"Flag to indicate that the allowance is shared"
        },
        "usageUnit":{
            "type":"string",
            "description":"Indicates the usage unit",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "allowanceValidity":{
            "title":"AllowanceValidityOracle",
            "type":"object",
            "description":"Validity of allowance",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the amount of allowance validity"
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of allowance validity",
                    "enum":[
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "ACCOUNTING_CYCLE",
                        "BILLING_CYCLE"
                    ]
                },
                "startCriteria":{
                    "type":"string",
                    "description":"Indicates start criteria of allowance validity.",
                    "enum":[
                        "EVENT_OCCURRENCE",
                        "FIRST_USAGE"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        }
    }
}

Nested Schema : AllowanceValidityOracle

Type: object

Title: AllowanceValidityOracle

Validity of allowance

Show Source

• startCriteria: string
  Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]

  Indicates start criteria of allowance validity.
• unit(required): string
  Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]

  Indicates the unit of allowance validity
• value(required): number
  Indicates the amount of allowance validity

{
    "title":"AllowanceValidityOracle",
    "type":"object",
    "description":"Validity of allowance",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the amount of allowance validity"
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of allowance validity",
            "enum":[
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "ACCOUNTING_CYCLE",
                "BILLING_CYCLE"
            ]
        },
        "startCriteria":{
            "type":"string",
            "description":"Indicates start criteria of allowance validity.",
            "enum":[
                "EVENT_OCCURRENCE",
                "FIRST_USAGE"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]

Type: object

Show Source

• rolloverFrequency: string
  Allowed Values: [ "MONTH" ]

  The period to repeat the rollover for.
• rolloverRules: array rolloverRules

{
    "type":"object",
    "properties":{
        "rolloverFrequency":{
            "type":"string",
            "description":"The period to repeat the rollover for.",
            "enum":[
                "MONTH"
            ]
        },
        "rolloverRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RolloverRuleOracle"
            }
        }
    }
}

Nested Schema : rolloverRules

Type: array

Show Source

• Array of: object RolloverRuleOracle
  Title: RolloverRuleOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RolloverRuleOracle"
    }
}

Nested Schema : RolloverRuleOracle

Type: object

Title: RolloverRuleOracle

Show Source

• balanceElement: object BalanceElementRef
  Title: BalanceElementRef

  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
  GLID for the rollover charge.
• id(required): string
  Maximum Length: 30

  Unique identifier of the rollover.
• maxCumulativeRolloverAmount: number
  Maximum rollover amount that can be accumulated.
• maximumRolloverCycles: object MaximumRolloverCycleOracle
  Title: MaximumRolloverCycleOracle

  Indicates the maximum allowed rollover cycles and the unit.
• maxRolloverAmountPerCycle: number
  Maximum amount that can be rolled over in a cycle.
• unitOfMeasure: string
  The unit of measure for which the priceTag rule applies to.

{
    "title":"RolloverRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the rollover."
        },
        "balanceElementCode":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency"
        },
        "maxRolloverAmountPerCycle":{
            "type":"number",
            "description":"Maximum amount that can be rolled over in a cycle."
        },
        "maxCumulativeRolloverAmount":{
            "type":"number",
            "description":"Maximum rollover amount that can be accumulated."
        },
        "maximumRolloverCycles":{
            "title":"MaximumRolloverCycleOracle",
            "type":"object",
            "description":"Indicates the maximum allowed rollover cycles and the unit.",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the number of rollover cycles."
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of rollover cycle.",
                    "enum":[
                        "DAYS",
                        "WEEKS",
                        "MONTHS",
                        "YEARS"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        },
        "glid":{
            "type":"string",
            "description":"GLID for the rollover charge."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for which the priceTag rule applies to."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef"
        }
    },
    "required":[
        "id",
        "balanceElementCode"
    ]
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

Balance element ref in price

Show Source

• @baseType: string
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  The Class type of referred balance element
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  Indicates the (class) type of balance element.
• href: string
  Unique reference of the balance element
• id(required): string
  Unique identifier of the balance element
• name: string
  Name of the balance element
• version: string
  Version of the balance element
• versionState: number
  To hold the version state of reference

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"Balance element ref in price",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the balance element"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the balance element"
        },
        "version":{
            "type":"string",
            "description":"Version of the balance element"
        },
        "name":{
            "type":"string",
            "description":"Name of the balance element"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of balance element."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred balance element"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : MaximumRolloverCycleOracle

Type: object

Title: MaximumRolloverCycleOracle

Indicates 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.
• value(required): number
  Indicates the number of rollover cycles.

{
    "title":"MaximumRolloverCycleOracle",
    "type":"object",
    "description":"Indicates the maximum allowed rollover cycles and the unit.",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the number of rollover cycles."
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of rollover cycle.",
            "enum":[
                "DAYS",
                "WEEKS",
                "MONTHS",
                "YEARS"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferingPriceOverageOracle-allOf[1]

Type: object

Nested Schema : ProductOfferingPricePlanOracle-allOf[1]

Type: object

Show Source

• alterationType: string
  Allowed Values: [ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE" ]

  Describe the alteration price
• compositePopRelationship: array compositePopRelationship
• priceRange: string
  Indicates the range of prices this price plan defines
• usageSpecMeteringRuleUse: array usageSpecMeteringRuleUse

{
    "type":"object",
    "properties":{
        "alterationType":{
            "type":"string",
            "description":"Describe the alteration price",
            "enum":[
                "DISCOUNT",
                "MARKUP",
                "OVERRIDE",
                "DISCOUNT_OVERRIDE"
            ]
        },
        "priceRange":{
            "type":"string",
            "description":"Indicates the range of prices this price plan defines"
        },
        "compositePopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositePopRelationshipOracle"
            }
        },
        "usageSpecMeteringRuleUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
            }
        }
    }
}

Nested Schema : compositePopRelationship

Type: array

Show Source

• Array of: object CompositePopRelationshipOracle
  Title: CompositePopRelationshipOracle

  this object represents a composite relationship from a product offering price (parent) to a simple product offering price (child).

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositePopRelationshipOracle"
    }
}

Nested Schema : usageSpecMeteringRuleUse

Type: array

Show Source

• Array of: object UsageSpecMeteringRuleUse
  Title: UsageSpecMeteringRuleUse

  Metering rules used in the usage price plan

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
    }
}

Nested Schema : CompositePopRelationshipOracle

Type: object

Title: CompositePopRelationshipOracle

this object represents a composite relationship from a product offering price (parent) to a simple product offering price (child).

Show Source

• @baseType: string
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  A string. The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  (Class) type of the associated product offering
• href: string
  hyperlink reference of the associated product offering price
• id(required): string
  Unique identifier of the associated product offering price
• name: string
  Name of the associated product offering price
• relationshipType: string
  Allowed Values: [ "COMPOSITE" ]

  POP relationship type
• version: string
  version of the associated product offering price

{
    "title":"CompositePopRelationshipOracle",
    "type":"object",
    "description":"this object represents a composite relationship from a  product offering price (parent) to a simple product offering price (child).",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the associated product offering price"
        },
        "href":{
            "type":"string",
            "description":"hyperlink reference of the associated product offering price"
        },
        "name":{
            "type":"string",
            "description":"Name of  the associated product offering price"
        },
        "version":{
            "type":"string",
            "description":"version of  the associated product offering price"
        },
        "relationshipType":{
            "type":"string",
            "description":"POP relationship type",
            "enum":[
                "COMPOSITE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"(Class) type of the associated product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"A string. The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : UsageSpecMeteringRuleUse

Type: object

Title: UsageSpecMeteringRuleUse

Metering rules used in the usage price plan

Show Source

• id(required): string
  ID of the Metering Rule
• name(required): string
  Name of the associated Metering Rule
• usageSpecification(required): UsageSpecificationRefOracle
  Title: UsageSpecificationRefOracle

{
    "title":"UsageSpecMeteringRuleUse",
    "type":"object",
    "description":"Metering rules used in the usage price plan",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the associated Metering Rule"
        },
        "id":{
            "type":"string",
            "description":"ID of the Metering Rule"
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        }
    },
    "required":[
        "name",
        "id",
        "usageSpecification"
    ]
}

Nested Schema : UsageSpecificationRefOracle

Title: UsageSpecificationRefOracle

Match All

Show Source

• object UsageSpecificationRef
  Title: UsageSpecificationRef

  Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }

  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]

{
    "title":"UsageSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "usageCode":{
                    "type":"string",
                    "description":"Code to usage specification"
                }
            }
        }
    ]
}

Nested Schema : UsageSpecificationRef

Type: object

Title: UsageSpecificationRef

Discriminator: @type

Discriminator Values

• UsageSpecificationRef
• UsageSpecificationRefOracle

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

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
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  (Class) type of the referred Usage Specification.
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  Indicates the (class) type of ServiceSpecificationRef.
• href: string
  Reference of the usage specification.
• id(required): string
  Unique identifier of the usage specification.
• name: string
  Name of the usage specification.
• version: string
  Version of the usage specification.
• versionState: number
  To hold the version state for the reference

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

Nested Schema : UsageSpecificationRefOracle-allOf[1]

Type: object

Show Source

• usageCode: string
  Code to usage specification

{
    "type":"object",
    "properties":{
        "usageCode":{
            "type":"string",
            "description":"Code to usage specification"
        }
    }
}

Nested Schema : PenaltyPriceOracle-allOf[1]

Type: object

Show Source

• prorationReductionTerm: array prorationReductionTerm

{
    "type":"object",
    "properties":{
        "prorationReductionTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProrationReductionTermOracle"
            }
        }
    }
}

Nested Schema : prorationReductionTerm

Type: array

Show Source

• Array of: object ProrationReductionTerm
  Title: ProrationReductionTerm

  Provides 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProrationReductionTermOracle"
    }
}

Nested Schema : ProrationReductionTerm

Type: object

Title: ProrationReductionTerm

Provides 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" ]

  Term duration units
• fromOffset: number
  Start of the schedule
• reductionPercentage: number
  Percentage of the amount to be deducted

{
    "title":"ProrationReductionTerm",
    "type":"object",
    "description":"Provides 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.",
    "properties":{
        "fromOffset":{
            "type":"number",
            "description":"Start of the schedule"
        },
        "reductionPercentage":{
            "type":"number",
            "description":"Percentage of the amount to be deducted"
        },
        "durationUnits":{
            "type":"string",
            "description":"Term duration units",
            "enum":[
                "DAYS",
                "MONTHS",
                "WEEKS",
                "YEARS"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ProductOfferingPrice_Schemas

Type: object

Title: ProductOfferingPrice_Schemas

Discriminator: @type

Discriminator Values

• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "title":"ProductOfferingPrice_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
        },
        {
            "$ref":"#/components/schemas/PenaltyPriceOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Match One Schema

Show Source

• ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• ProductOfferingPriceAlterationOracle
  Title: ProductOfferingPriceAlterationOracle
• ProductOfferingPriceCounterOracle
  Title: ProductOfferingPriceCounterOracle
• ProductOfferingPriceAllowanceOracle
  Title: ProductOfferingPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
  Title: ProductOfferRolloverPriceOracle
• ProductOfferingPriceOverageOracle
  Title: ProductOfferingPriceOverageOracle
• ProductOfferingPricePlanOracle
  Title: ProductOfferingPricePlanOracle
• PenaltyPriceOracle
  Title: PenaltyPriceOracle

{
    "title":"ProductOfferingPrice_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
        },
        {
            "$ref":"#/components/schemas/PenaltyPriceOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : ProductOfferingPriceOracle

Title: ProductOfferingPriceOracle

Match All

Show Source

• object ProductOfferingPrice
  Title: ProductOfferingPrice

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }

{
    "title":"ProductOfferingPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPrice"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "isTaxInclusive":{
                    "type":"boolean",
                    "description":"Indicates id the price is inclusive of tax"
                },
                "priceSubType":{
                    "type":"string",
                    "description":"tag of the price like Overage, Allowance, Installment  etc.",
                    "enum":[
                        "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"
                    ]
                },
                "priceTag":{
                    "type":"string",
                    "description":"PriceTag for the price."
                },
                "oneTimeFeeType":{
                    "type":"string",
                    "description":"Indicates the one time fee type. The default value is PURCHASE.",
                    "enum":[
                        "PURCHASE",
                        "CANCEL",
                        "PENALTY"
                    ]
                },
                "recurringFeeType":{
                    "type":"string",
                    "description":"Indicates the recurring fee type. The default value is CYCLE.",
                    "enum":[
                        "CYCLE",
                        "CYCLE_ARREAR",
                        "CYCLE_FWD_ARREAR"
                    ]
                },
                "priceTagValueObject":{
                    "$ref":"#/components/schemas/PriceTagRefOracle"
                },
                "pricelist":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceListRefOracle"
                    }
                },
                "customProfileSpec":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
                    }
                },
                "usageSpecification":{
                    "$ref":"#/components/schemas/UsageSpecificationRefOracle"
                },
                "balanceElement":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/BalanceElementRef"
                    }
                },
                "relativeValidFor":{
                    "$ref":"#/components/schemas/TimePeriodRelativeOracle"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the productOfferingPrice"
                },
                "triggerConditionGroup":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TriggerConditionGroupOracle"
                    }
                },
                "counter":{
                    "type":"array",
                    "items":{
                        "anyOf":[
                            {
                                "$ref":"#/components/schemas/ProductOfferingPriceRef"
                            },
                            {
                                "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                            }
                        ],
                        "discriminator":{
                            "propertyName":"@type",
                            "mapping":{
                                "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                                "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                            }
                        }
                    }
                },
                "alterationAppliedOn":{
                    "type":"string",
                    "description":"indicates sharing option for the alteration price",
                    "enum":[
                        "USER_BALANCE",
                        "SHARER_BALANCE"
                    ]
                },
                "discountMode":{
                    "type":"string",
                    "description":"Indicates the mode of processing discounts.",
                    "enum":[
                        "SEQUENTIAL",
                        "PARALLEL"
                    ]
                },
                "chargeType":{
                    "type":"string",
                    "description":"Indicates the charge type for the alteration.",
                    "enum":[
                        "DEBIT",
                        "CREDIT"
                    ]
                }
            },
            "discriminator":{
                "propertyName":"@type",
                "mapping":{
                    "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
                    "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
                    "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
                    "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
                    "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
                    "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
                    "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
                    "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceAlterationOracle

Title: ProductOfferingPriceAlterationOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceAlterationOracle-allOf[1]

{
    "title":"ProductOfferingPriceAlterationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "priority":{
                    "type":"integer",
                    "description":"Priority of this resource represented in numerical value."
                },
                "discountEligibility":{
                    "$ref":"#/components/schemas/PriceEligibilityOracle"
                },
                "alterationType":{
                    "type":"string",
                    "description":"Describe the alteration price",
                    "enum":[
                        "DISCOUNT",
                        "MARKUP",
                        "OVERRIDE",
                        "DISCOUNT_OVERRIDE",
                        "CHARGE_SHARE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceCounterOracle

Title: ProductOfferingPriceCounterOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceCounterOracle-allOf[1]

{
    "title":"ProductOfferingPriceCounterOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "counterValidity":{
                    "title":"CounterValidityOracle",
                    "type":"object",
                    "description":"Validity of counter",
                    "properties":{
                        "value":{
                            "type":"number",
                            "description":"Indicates the value of counter validity"
                        },
                        "unit":{
                            "type":"string",
                            "description":"Indicates the unit of counter validity",
                            "enum":[
                                "SECOND",
                                "MINUTE",
                                "HOUR",
                                "DAY",
                                "MONTH",
                                "ACCOUNTING_CYCLE",
                                "BILLING_CYCLE"
                            ]
                        },
                        "startCriteria":{
                            "type":"string",
                            "description":"Indicates start criteria of counter validity.",
                            "enum":[
                                "EVENT_OCCURRENCE",
                                "FIRST_USAGE"
                            ]
                        }
                    },
                    "required":[
                        "value",
                        "unit"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceAllowanceOracle

Title: ProductOfferingPriceAllowanceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceAllowanceOracle-allOf[1]

{
    "title":"ProductOfferingPriceAllowanceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "shareAllowance":{
                    "type":"boolean",
                    "description":"Flag to indicate that the allowance is shared"
                },
                "usageUnit":{
                    "type":"string",
                    "description":"Indicates the usage unit",
                    "enum":[
                        "NONE",
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "BYTE",
                        "KILOBYTE",
                        "MEGABYTE",
                        "GIGABYTE",
                        "PAGES",
                        "MOVIES",
                        "TIME_INTERVAL",
                        "QUANTITY",
                        "MBPS",
                        "GBPS"
                    ]
                },
                "allowanceValidity":{
                    "title":"AllowanceValidityOracle",
                    "type":"object",
                    "description":"Validity of allowance",
                    "properties":{
                        "value":{
                            "type":"number",
                            "description":"Indicates the amount of allowance validity"
                        },
                        "unit":{
                            "type":"string",
                            "description":"Indicates the unit of allowance validity",
                            "enum":[
                                "SECOND",
                                "MINUTE",
                                "HOUR",
                                "DAY",
                                "MONTH",
                                "ACCOUNTING_CYCLE",
                                "BILLING_CYCLE"
                            ]
                        },
                        "startCriteria":{
                            "type":"string",
                            "description":"Indicates start criteria of allowance validity.",
                            "enum":[
                                "EVENT_OCCURRENCE",
                                "FIRST_USAGE"
                            ]
                        }
                    },
                    "required":[
                        "value",
                        "unit"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ProductOfferRolloverPriceOracle

Title: ProductOfferRolloverPriceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferRolloverPriceOracle-allOf[1]

{
    "title":"ProductOfferRolloverPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "rolloverFrequency":{
                    "type":"string",
                    "description":"The period to repeat the rollover for.",
                    "enum":[
                        "MONTH"
                    ]
                },
                "rolloverRules":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RolloverRuleOracle"
                    }
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPriceOverageOracle

Title: ProductOfferingPriceOverageOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPriceOverageOracle-allOf[1]

{
    "title":"ProductOfferingPriceOverageOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ProductOfferingPricePlanOracle

Title: ProductOfferingPricePlanOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object ProductOfferingPricePlanOracle-allOf[1]

{
    "title":"ProductOfferingPricePlanOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "alterationType":{
                    "type":"string",
                    "description":"Describe the alteration price",
                    "enum":[
                        "DISCOUNT",
                        "MARKUP",
                        "OVERRIDE",
                        "DISCOUNT_OVERRIDE"
                    ]
                },
                "priceRange":{
                    "type":"string",
                    "description":"Indicates the range of prices this price plan defines"
                },
                "compositePopRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CompositePopRelationshipOracle"
                    }
                },
                "usageSpecMeteringRuleUse":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
                    }
                }
            }
        }
    ]
}

Nested Schema : PenaltyPriceOracle

Title: PenaltyPriceOracle

Match All

Show Source

• allOf ProductOfferingPriceOracle
  Title: ProductOfferingPriceOracle
• object PenaltyPriceOracle-allOf[1]

{
    "title":"PenaltyPriceOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "type":"object",
            "properties":{
                "prorationReductionTerm":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProrationReductionTermOracle"
                    }
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingPrice

Type: object

Title: ProductOfferingPrice

Discriminator: @type

Discriminator Values

• ProductOfferingPrice
• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "title":"ProductOfferingPrice",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the productOfferingPrice"
        },
        "description":{
            "type":"string",
            "description":"Description of the productOfferingPrice"
        },
        "version":{
            "type":"string",
            "description":"ProductOfferingPrice version"
        },
        "glid":{
            "type":"string",
            "description":"glid"
        },
        "discountable":{
            "type":"boolean",
            "description":"A flag indicating if this POP is discountable or not"
        },
        "billOnPurchase":{
            "type":"boolean",
            "description":"A flag indicating if a bill on purchase is to be provided or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "unitOfMeasure":{
            "$ref":"#/components/schemas/Quantity"
        },
        "recurringChargePeriodType":{
            "type":"string",
            "description":"The period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.",
            "enum":[
                "MONTHLY",
                "BI_MONTHLY",
                "QUARTERLY",
                "SEMI_ANNUAL",
                "ANNUAL",
                "DAILY"
            ]
        },
        "recurringChargePeriodLength":{
            "type":"integer",
            "description":"The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering price"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering price"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicating if this POP is composite (bundle) or not"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "price":{
            "$ref":"#/components/schemas/Money"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage to apply for ProdOfferPriceAlteration"
        },
        "bundledPopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOfferingPriceRelationship"
            }
        },
        "popRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRelationship"
            }
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            }
        },
        "specCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SpecCharValueUse"
            }
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/CommitmentTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/SubscriptionTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/PaymentTermOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
                        "ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
                        "CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
                        "SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
                        "PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
                    }
                }
            }
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PolicyRef"
            }
        },
        "pricingLogicAlgorithm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PricingLogicAlgorithmRef"
            }
        },
        "tax":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "alterationBasedOn":{
            "$ref":"#/components/schemas/AlterationBasedOnOracle"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Show Source

• @baseType: string
  Immediate base (class) type of the product offering price
• @schemaLocation: string
  A link to the schema describing this product offering price
• @type(required): string
  Class type of the product offering price
• alterationBasedOn: object AlterationBasedOnOracle
  Title: AlterationBasedOnOracle

  A number, unit and an expression representing the relative alteration.
• billOnPurchase: boolean
  A flag indicating if a bill on purchase is to be provided or not
• bundledPopRelationship: array bundledPopRelationship
• description: string
  Description of the productOfferingPrice
• discountable: boolean
  A flag indicating if this POP is discountable or not
• glid: string
  glid
• href: string
  Hyperlink reference of this resource
• id: string
  Maximum Length: 30

  Unique id of this resource
• isBundle: boolean
  A flag indicating if this POP is composite (bundle) or not
• lastUpdate: string (date-time)
  Date and time of the last update
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name: string
  Name of the productOfferingPrice
• percentage: number
  Percentage to apply for ProdOfferPriceAlteration
• place: array place
• policy: array policy
• popRelationship: array popRelationship
• price: object Money
  Title: Money

  The 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" ]

  Describes the price, such as recurring, discount, allowance, penalty, and so forth
• pricingLogicAlgorithm: array pricingLogicAlgorithm
• prodSpecCharValueUse: array prodSpecCharValueUse
• productOfferingTerm: array productOfferingTerm
• 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 period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.
• specCharValueUse: array specCharValueUse
• tax: array tax
• unitOfMeasure: object Quantity
  Title: Quantity

  A number and unit representing how many of an ProductOffering is available at the offered price.
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  ProductOfferingPrice version

{
    "title":"ProductOfferingPrice",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the productOfferingPrice"
        },
        "description":{
            "type":"string",
            "description":"Description of the productOfferingPrice"
        },
        "version":{
            "type":"string",
            "description":"ProductOfferingPrice version"
        },
        "glid":{
            "type":"string",
            "description":"glid"
        },
        "discountable":{
            "type":"boolean",
            "description":"A flag indicating if this POP is discountable or not"
        },
        "billOnPurchase":{
            "type":"boolean",
            "description":"A flag indicating if a bill on purchase is to be provided or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "unitOfMeasure":{
            "$ref":"#/components/schemas/Quantity"
        },
        "recurringChargePeriodType":{
            "type":"string",
            "description":"The period to repeat the application of the price. For recurring price, if no value is provided for this field, it will be set to MONTHLY.",
            "enum":[
                "MONTHLY",
                "BI_MONTHLY",
                "QUARTERLY",
                "SEMI_ANNUAL",
                "ANNUAL",
                "DAILY"
            ]
        },
        "recurringChargePeriodLength":{
            "type":"integer",
            "description":"The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering price"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering price"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicating if this POP is composite (bundle) or not"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "price":{
            "$ref":"#/components/schemas/Money"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage to apply for ProdOfferPriceAlteration"
        },
        "bundledPopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOfferingPriceRelationship"
            }
        },
        "popRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRelationship"
            }
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            }
        },
        "specCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SpecCharValueUse"
            }
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/CommitmentTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/SubscriptionTermOracle"
                    },
                    {
                        "$ref":"#/components/schemas/PaymentTermOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
                        "ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
                        "CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
                        "SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
                        "PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
                    }
                }
            }
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            }
        },
        "policy":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PolicyRef"
            }
        },
        "pricingLogicAlgorithm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PricingLogicAlgorithmRef"
            }
        },
        "tax":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "alterationBasedOn":{
            "$ref":"#/components/schemas/AlterationBasedOnOracle"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOfferingPriceOracle
• ProductOfferPriceAlterationOracle
• ProductOfferPriceAllowanceOracle
• ProductOfferRolloverPriceOracle
• ProductOfferPriceCounterOracle
• ProductOfferPriceOverageOracle
• ProductOfferPricePlanOracle
• PenaltyPriceOracle

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "isTaxInclusive":{
            "type":"boolean",
            "description":"Indicates id the price is inclusive of tax"
        },
        "priceSubType":{
            "type":"string",
            "description":"tag of the price like Overage, Allowance, Installment  etc.",
            "enum":[
                "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"
            ]
        },
        "priceTag":{
            "type":"string",
            "description":"PriceTag for the price."
        },
        "oneTimeFeeType":{
            "type":"string",
            "description":"Indicates the one time fee type. The default value is PURCHASE.",
            "enum":[
                "PURCHASE",
                "CANCEL",
                "PENALTY"
            ]
        },
        "recurringFeeType":{
            "type":"string",
            "description":"Indicates the recurring fee type. The default value is CYCLE.",
            "enum":[
                "CYCLE",
                "CYCLE_ARREAR",
                "CYCLE_FWD_ARREAR"
            ]
        },
        "priceTagValueObject":{
            "$ref":"#/components/schemas/PriceTagRefOracle"
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        },
        "balanceElement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceElementRef"
            }
        },
        "relativeValidFor":{
            "$ref":"#/components/schemas/TimePeriodRelativeOracle"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the productOfferingPrice"
        },
        "triggerConditionGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TriggerConditionGroupOracle"
            }
        },
        "counter":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceRef"
                    },
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                        "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                }
            }
        },
        "alterationAppliedOn":{
            "type":"string",
            "description":"indicates sharing option for the alteration price",
            "enum":[
                "USER_BALANCE",
                "SHARER_BALANCE"
            ]
        },
        "discountMode":{
            "type":"string",
            "description":"Indicates the mode of processing discounts.",
            "enum":[
                "SEQUENTIAL",
                "PARALLEL"
            ]
        },
        "chargeType":{
            "type":"string",
            "description":"Indicates the charge type for the alteration.",
            "enum":[
                "DEBIT",
                "CREDIT"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Show Source

• alterationAppliedOn: string
  Allowed Values: [ "USER_BALANCE", "SHARER_BALANCE" ]

  indicates sharing option for the alteration price
• applicationName: string
  name of the external application
• balanceElement: array balanceElement
• chargeType: string
  Allowed Values: [ "DEBIT", "CREDIT" ]

  Indicates the charge type for the alteration.
• counter: array counter
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• customProfileSpec: array customProfileSpec
• discountMode: string
  Allowed Values: [ "SEQUENTIAL", "PARALLEL" ]

  Indicates the mode of processing discounts.
• externalId: string
  id of the external application
• isTaxInclusive: boolean
  Indicates id the price is inclusive of tax
• lastUpdatedBy: string
  name of the person who updated item
• oneTimeFeeType: string
  Allowed Values: [ "PURCHASE", "CANCEL", "PENALTY" ]

  Indicates the one time fee type. The default value is PURCHASE.
• pricelist: array pricelist
• 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" ]

  tag of the price like Overage, Allowance, Installment etc.
• priceTag: string
  PriceTag for the price.
• priceTagValueObject: object PriceTagRefOracle
  Title: PriceTagRefOracle

  PriceTag reference.
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• recurringFeeType: string
  Allowed Values: [ "CYCLE", "CYCLE_ARREAR", "CYCLE_FWD_ARREAR" ]

  Indicates the recurring fee type. The default value is CYCLE.
• relativeValidFor: object TimePeriodRelativeOracle
  Title: TimePeriodRelativeOracle

  Relative validity period of the related party
• triggerConditionGroup: array triggerConditionGroup
• usageSpecification: UsageSpecificationRefOracle
  Title: UsageSpecificationRefOracle
• versionState: number
  Version state of the productOfferingPrice

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "isTaxInclusive":{
            "type":"boolean",
            "description":"Indicates id the price is inclusive of tax"
        },
        "priceSubType":{
            "type":"string",
            "description":"tag of the price like Overage, Allowance, Installment  etc.",
            "enum":[
                "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"
            ]
        },
        "priceTag":{
            "type":"string",
            "description":"PriceTag for the price."
        },
        "oneTimeFeeType":{
            "type":"string",
            "description":"Indicates the one time fee type. The default value is PURCHASE.",
            "enum":[
                "PURCHASE",
                "CANCEL",
                "PENALTY"
            ]
        },
        "recurringFeeType":{
            "type":"string",
            "description":"Indicates the recurring fee type. The default value is CYCLE.",
            "enum":[
                "CYCLE",
                "CYCLE_ARREAR",
                "CYCLE_FWD_ARREAR"
            ]
        },
        "priceTagValueObject":{
            "$ref":"#/components/schemas/PriceTagRefOracle"
        },
        "pricelist":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceListRefOracle"
            }
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        },
        "balanceElement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceElementRef"
            }
        },
        "relativeValidFor":{
            "$ref":"#/components/schemas/TimePeriodRelativeOracle"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the productOfferingPrice"
        },
        "triggerConditionGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TriggerConditionGroupOracle"
            }
        },
        "counter":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceRef"
                    },
                    {
                        "$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
                        "ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
                    }
                }
            }
        },
        "alterationAppliedOn":{
            "type":"string",
            "description":"indicates sharing option for the alteration price",
            "enum":[
                "USER_BALANCE",
                "SHARER_BALANCE"
            ]
        },
        "discountMode":{
            "type":"string",
            "description":"Indicates the mode of processing discounts.",
            "enum":[
                "SEQUENTIAL",
                "PARALLEL"
            ]
        },
        "chargeType":{
            "type":"string",
            "description":"Indicates the charge type for the alteration.",
            "enum":[
                "DEBIT",
                "CREDIT"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

Nested Schema : ProductOfferingPriceAlterationOracle-allOf[1]

Type: object

Show Source

• alterationType: string
  Allowed Values: [ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "CHARGE_SHARE" ]

  Describe the alteration price
• discountEligibility: object PriceEligibilityOracle
  Title: PriceEligibilityOracle

  specifies the eligibility rule for the offer
• priority: integer
  Priority of this resource represented in numerical value.

{
    "type":"object",
    "properties":{
        "priority":{
            "type":"integer",
            "description":"Priority of this resource represented in numerical value."
        },
        "discountEligibility":{
            "$ref":"#/components/schemas/PriceEligibilityOracle"
        },
        "alterationType":{
            "type":"string",
            "description":"Describe the alteration price",
            "enum":[
                "DISCOUNT",
                "MARKUP",
                "OVERRIDE",
                "DISCOUNT_OVERRIDE",
                "CHARGE_SHARE"
            ]
        }
    }
}

Nested Schema : PriceEligibilityOracle

Type: object

Title: PriceEligibilityOracle

specifies the eligibility rule for the offer

Show Source

• active: boolean
  A flag indicating if the rule is active or not
• description: string
  A narrative text describing the eligibility rule
• eligibilityExpression: array eligibilityExpression
• id: string
  A string. Unique identifier of the pricing eligibility rule.
• name(required): string
  Name of the eligibility rule
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"PriceEligibilityOracle",
    "type":"object",
    "description":"specifies the eligibility rule for the offer",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the pricing eligibility rule."
        },
        "name":{
            "type":"string",
            "description":"Name of the eligibility rule"
        },
        "description":{
            "type":"string",
            "description":"A narrative text describing the eligibility rule"
        },
        "eligibilityExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EligibilityExpressionOracle"
            }
        },
        "active":{
            "type":"boolean",
            "description":"A flag indicating if the rule is active or not"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : eligibilityExpression

Type: array

Show Source

• Array of: object EligibilityExpressionOracle
  Title: EligibilityExpressionOracle

  A eligibility expression

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EligibilityExpressionOracle"
    }
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : EligibilityExpressionOracle

Type: object

Title: EligibilityExpressionOracle

A eligibility expression

Show Source

• @baseType: string
  The immediate base class type of the Elibility Expression
• @schemaLocation: string
  A link to the schema describing this Elibility Expression entity
• @type(required): string
  the class type of the Elibility Expression
• expressionRelationship: array expressionRelationship
• expressionType(required): string
  Allowed Values: [ "ARITHMATIC", "NUMERIC", "LOGICAL", "CHARGE", "QUANTITY", "BALANCE" ]

  Expression Type of the expression
• id(required): string
  A string. Unique identifier of the eligibility expression.
• operator: string
  Operator of the expression
• value: value
  A discrete value that the relationship can take on.

{
    "type":"object",
    "title":"EligibilityExpressionOracle",
    "description":"A eligibility expression",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the eligibility expression."
        },
        "operator":{
            "type":"string",
            "description":"Operator of the expression"
        },
        "expressionType":{
            "type":"string",
            "description":"Expression Type of the expression",
            "enum":[
                "ARITHMATIC",
                "NUMERIC",
                "LOGICAL",
                "CHARGE",
                "QUANTITY",
                "BALANCE"
            ]
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ],
            "description":"A discrete value that the relationship can take on."
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Elibility Expression"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Elibility Expression"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Elibility Expression entity"
        },
        "expressionRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExpressionRelationship"
            }
        }
    },
    "required":[
        "expressionType",
        "id",
        "@type"
    ]
}

Nested Schema : expressionRelationship

Type: array

Show Source

• Array of: object ExpressionRelationship
  Title: ExpressionRelationship

  An expression relationship

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExpressionRelationship"
    }
}

Nested Schema : value

A discrete value that the relationship can take on.

Match One Schema

Show Source

• string
• number
• boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ],
    "description":"A discrete value that the relationship can take on."
}

Nested Schema : ExpressionRelationship

Type: object

Title: ExpressionRelationship

An expression relationship

Show Source

• @baseType: string
  The immediate base class type of the Eligibity Expression Relationship
• @schemaLocation: string
  A link to the schema describing this Eligibity Expression Relationship entity
• @type(required): string
  the class type of the Eligibity Expression Relationship
• expressionId(required): string
  A string. The unique id given for the expression relationship
• href: string
  A string. The href given for the expression relationship
• name: string
  A string. The name given for the expression relationship
• relationshipType(required): string
  Allowed Values: [ "LEFT_HAND_SIDE", "RIGHT_HAND_SIDE" ]

  A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.

{
    "type":"object",
    "title":"ExpressionRelationship",
    "description":"An expression relationship",
    "properties":{
        "expressionId":{
            "type":"string",
            "description":"A string. The unique id given for the expression relationship"
        },
        "name":{
            "type":"string",
            "description":"A string. The name given for the expression relationship"
        },
        "href":{
            "type":"string",
            "description":"A string. The href given for the expression relationship"
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.",
            "enum":[
                "LEFT_HAND_SIDE",
                "RIGHT_HAND_SIDE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Eligibity Expression Relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Eligibity Expression Relationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Eligibity Expression Relationship entity"
        }
    },
    "required":[
        "relationshipType",
        "expressionId",
        "@type"
    ]
}

Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]

Type: object

Show Source

• counterValidity: object CounterValidityOracle
  Title: CounterValidityOracle

  Validity of counter

{
    "type":"object",
    "properties":{
        "counterValidity":{
            "title":"CounterValidityOracle",
            "type":"object",
            "description":"Validity of counter",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the value of counter validity"
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of counter validity",
                    "enum":[
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "ACCOUNTING_CYCLE",
                        "BILLING_CYCLE"
                    ]
                },
                "startCriteria":{
                    "type":"string",
                    "description":"Indicates start criteria of counter validity.",
                    "enum":[
                        "EVENT_OCCURRENCE",
                        "FIRST_USAGE"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        }
    }
}

Nested Schema : CounterValidityOracle

Type: object

Title: CounterValidityOracle

Validity of counter

Show Source

• startCriteria: string
  Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]

  Indicates start criteria of counter validity.
• unit(required): string
  Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]

  Indicates the unit of counter validity
• value(required): number
  Indicates the value of counter validity

{
    "title":"CounterValidityOracle",
    "type":"object",
    "description":"Validity of counter",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the value of counter validity"
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of counter validity",
            "enum":[
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "ACCOUNTING_CYCLE",
                "BILLING_CYCLE"
            ]
        },
        "startCriteria":{
            "type":"string",
            "description":"Indicates start criteria of counter validity.",
            "enum":[
                "EVENT_OCCURRENCE",
                "FIRST_USAGE"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]

Type: object

Show Source

• allowanceValidity: object AllowanceValidityOracle
  Title: AllowanceValidityOracle

  Validity of allowance
• shareAllowance: boolean
  Flag to indicate that the allowance is shared
• 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

{
    "type":"object",
    "properties":{
        "shareAllowance":{
            "type":"boolean",
            "description":"Flag to indicate that the allowance is shared"
        },
        "usageUnit":{
            "type":"string",
            "description":"Indicates the usage unit",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "allowanceValidity":{
            "title":"AllowanceValidityOracle",
            "type":"object",
            "description":"Validity of allowance",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the amount of allowance validity"
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of allowance validity",
                    "enum":[
                        "SECOND",
                        "MINUTE",
                        "HOUR",
                        "DAY",
                        "MONTH",
                        "ACCOUNTING_CYCLE",
                        "BILLING_CYCLE"
                    ]
                },
                "startCriteria":{
                    "type":"string",
                    "description":"Indicates start criteria of allowance validity.",
                    "enum":[
                        "EVENT_OCCURRENCE",
                        "FIRST_USAGE"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        }
    }
}

Nested Schema : AllowanceValidityOracle

Type: object

Title: AllowanceValidityOracle

Validity of allowance

Show Source

• startCriteria: string
  Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]

  Indicates start criteria of allowance validity.
• unit(required): string
  Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]

  Indicates the unit of allowance validity
• value(required): number
  Indicates the amount of allowance validity

{
    "title":"AllowanceValidityOracle",
    "type":"object",
    "description":"Validity of allowance",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the amount of allowance validity"
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of allowance validity",
            "enum":[
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "ACCOUNTING_CYCLE",
                "BILLING_CYCLE"
            ]
        },
        "startCriteria":{
            "type":"string",
            "description":"Indicates start criteria of allowance validity.",
            "enum":[
                "EVENT_OCCURRENCE",
                "FIRST_USAGE"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]

Type: object

Show Source

• rolloverFrequency: string
  Allowed Values: [ "MONTH" ]

  The period to repeat the rollover for.
• rolloverRules: array rolloverRules

{
    "type":"object",
    "properties":{
        "rolloverFrequency":{
            "type":"string",
            "description":"The period to repeat the rollover for.",
            "enum":[
                "MONTH"
            ]
        },
        "rolloverRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RolloverRuleOracle"
            }
        }
    }
}

Nested Schema : rolloverRules

Type: array

Show Source

• Array of: object RolloverRuleOracle
  Title: RolloverRuleOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RolloverRuleOracle"
    }
}

Nested Schema : RolloverRuleOracle

Type: object

Title: RolloverRuleOracle

Show Source

• balanceElement: object BalanceElementRef
  Title: BalanceElementRef

  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
  GLID for the rollover charge.
• id(required): string
  Maximum Length: 30

  Unique identifier of the rollover.
• maxCumulativeRolloverAmount: number
  Maximum rollover amount that can be accumulated.
• maximumRolloverCycles: object MaximumRolloverCycleOracle
  Title: MaximumRolloverCycleOracle

  Indicates the maximum allowed rollover cycles and the unit.
• maxRolloverAmountPerCycle: number
  Maximum amount that can be rolled over in a cycle.
• unitOfMeasure: string
  The unit of measure for which the priceTag rule applies to.

{
    "title":"RolloverRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the rollover."
        },
        "balanceElementCode":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency"
        },
        "maxRolloverAmountPerCycle":{
            "type":"number",
            "description":"Maximum amount that can be rolled over in a cycle."
        },
        "maxCumulativeRolloverAmount":{
            "type":"number",
            "description":"Maximum rollover amount that can be accumulated."
        },
        "maximumRolloverCycles":{
            "title":"MaximumRolloverCycleOracle",
            "type":"object",
            "description":"Indicates the maximum allowed rollover cycles and the unit.",
            "properties":{
                "value":{
                    "type":"number",
                    "description":"Indicates the number of rollover cycles."
                },
                "unit":{
                    "type":"string",
                    "description":"Indicates the unit of rollover cycle.",
                    "enum":[
                        "DAYS",
                        "WEEKS",
                        "MONTHS",
                        "YEARS"
                    ]
                }
            },
            "required":[
                "value",
                "unit"
            ]
        },
        "glid":{
            "type":"string",
            "description":"GLID for the rollover charge."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for which the priceTag rule applies to."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef"
        }
    },
    "required":[
        "id",
        "balanceElementCode"
    ]
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

Balance element ref in price

Show Source

• @baseType: string
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  The Class type of referred balance element
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  Indicates the (class) type of balance element.
• href: string
  Unique reference of the balance element
• id(required): string
  Unique identifier of the balance element
• name: string
  Name of the balance element
• version: string
  Version of the balance element
• versionState: number
  To hold the version state of reference

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"Balance element ref in price",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the balance element"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the balance element"
        },
        "version":{
            "type":"string",
            "description":"Version of the balance element"
        },
        "name":{
            "type":"string",
            "description":"Name of the balance element"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of balance element."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred balance element"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : MaximumRolloverCycleOracle

Type: object

Title: MaximumRolloverCycleOracle

Indicates 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.
• value(required): number
  Indicates the number of rollover cycles.

{
    "title":"MaximumRolloverCycleOracle",
    "type":"object",
    "description":"Indicates the maximum allowed rollover cycles and the unit.",
    "properties":{
        "value":{
            "type":"number",
            "description":"Indicates the number of rollover cycles."
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of rollover cycle.",
            "enum":[
                "DAYS",
                "WEEKS",
                "MONTHS",
                "YEARS"
            ]
        }
    },
    "required":[
        "value",
        "unit"
    ]
}

Nested Schema : ProductOfferingPriceOverageOracle-allOf[1]

Type: object

Nested Schema : ProductOfferingPricePlanOracle-allOf[1]

Type: object

Show Source

• alterationType: string
  Allowed Values: [ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE" ]

  Describe the alteration price
• compositePopRelationship: array compositePopRelationship
• priceRange: string
  Indicates the range of prices this price plan defines
• usageSpecMeteringRuleUse: array usageSpecMeteringRuleUse

{
    "type":"object",
    "properties":{
        "alterationType":{
            "type":"string",
            "description":"Describe the alteration price",
            "enum":[
                "DISCOUNT",
                "MARKUP",
                "OVERRIDE",
                "DISCOUNT_OVERRIDE"
            ]
        },
        "priceRange":{
            "type":"string",
            "description":"Indicates the range of prices this price plan defines"
        },
        "compositePopRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositePopRelationshipOracle"
            }
        },
        "usageSpecMeteringRuleUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
            }
        }
    }
}

Nested Schema : compositePopRelationship

Type: array

Show Source

• Array of: object CompositePopRelationshipOracle
  Title: CompositePopRelationshipOracle

  this object represents a composite relationship from a product offering price (parent) to a simple product offering price (child).

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositePopRelationshipOracle"
    }
}

Nested Schema : usageSpecMeteringRuleUse

Type: array

Show Source

• Array of: object UsageSpecMeteringRuleUse
  Title: UsageSpecMeteringRuleUse

  Metering rules used in the usage price plan

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
    }
}

Nested Schema : CompositePopRelationshipOracle

Type: object

Title: CompositePopRelationshipOracle

this object represents a composite relationship from a product offering price (parent) to a simple product offering price (child).

Show Source

• @baseType: string
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  A string. The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  (Class) type of the associated product offering
• href: string
  hyperlink reference of the associated product offering price
• id(required): string
  Unique identifier of the associated product offering price
• name: string
  Name of the associated product offering price
• relationshipType: string
  Allowed Values: [ "COMPOSITE" ]

  POP relationship type
• version: string
  version of the associated product offering price

{
    "title":"CompositePopRelationshipOracle",
    "type":"object",
    "description":"this object represents a composite relationship from a  product offering price (parent) to a simple product offering price (child).",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the associated product offering price"
        },
        "href":{
            "type":"string",
            "description":"hyperlink reference of the associated product offering price"
        },
        "name":{
            "type":"string",
            "description":"Name of  the associated product offering price"
        },
        "version":{
            "type":"string",
            "description":"version of  the associated product offering price"
        },
        "relationshipType":{
            "type":"string",
            "description":"POP relationship type",
            "enum":[
                "COMPOSITE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"(Class) type of the associated product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"A string. The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : UsageSpecMeteringRuleUse

Type: object

Title: UsageSpecMeteringRuleUse

Metering rules used in the usage price plan

Show Source

• id(required): string
  ID of the Metering Rule
• name(required): string
  Name of the associated Metering Rule
• usageSpecification(required): UsageSpecificationRefOracle
  Title: UsageSpecificationRefOracle

{
    "title":"UsageSpecMeteringRuleUse",
    "type":"object",
    "description":"Metering rules used in the usage price plan",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the associated Metering Rule"
        },
        "id":{
            "type":"string",
            "description":"ID of the Metering Rule"
        },
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        }
    },
    "required":[
        "name",
        "id",
        "usageSpecification"
    ]
}

Nested Schema : UsageSpecificationRefOracle

Title: UsageSpecificationRefOracle

Match All

Show Source

• object UsageSpecificationRef
  Title: UsageSpecificationRef

  Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }

  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]

{
    "title":"UsageSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "usageCode":{
                    "type":"string",
                    "description":"Code to usage specification"
                }
            }
        }
    ]
}

Nested Schema : UsageSpecificationRef

Type: object

Title: UsageSpecificationRef

Discriminator: @type

Discriminator Values

• UsageSpecificationRef
• UsageSpecificationRefOracle

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

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
  Indicates the base (class) type of this REST resource
• @referredType(required): string
  (Class) type of the referred Usage Specification.
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type(required): string
  Indicates the (class) type of ServiceSpecificationRef.
• href: string
  Reference of the usage specification.
• id(required): string
  Unique identifier of the usage specification.
• name: string
  Name of the usage specification.
• version: string
  Version of the usage specification.
• versionState: number
  To hold the version state for the reference

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

Nested Schema : UsageSpecificationRefOracle-allOf[1]

Type: object

Show Source

• usageCode: string
  Code to usage specification

{
    "type":"object",
    "properties":{
        "usageCode":{
            "type":"string",
            "description":"Code to usage specification"
        }
    }
}

Nested Schema : PenaltyPriceOracle-allOf[1]

Type: object

Show Source

• prorationReductionTerm: array prorationReductionTerm

{
    "type":"object",
    "properties":{
        "prorationReductionTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProrationReductionTermOracle"
            }
        }
    }
}

Nested Schema : prorationReductionTerm

Type: array

Show Source

• Array of: object ProrationReductionTerm
  Title: ProrationReductionTerm

  Provides 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProrationReductionTermOracle"
    }
}

Nested Schema : ProrationReductionTerm

Type: object

Title: ProrationReductionTerm

Provides 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" ]

  Term duration units
• fromOffset: number
  Start of the schedule
• reductionPercentage: number
  Percentage of the amount to be deducted

{
    "title":"ProrationReductionTerm",
    "type":"object",
    "description":"Provides 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.",
    "properties":{
        "fromOffset":{
            "type":"number",
            "description":"Start of the schedule"
        },
        "reductionPercentage":{
            "type":"number",
            "description":"Percentage of the amount to be deducted"
        },
        "durationUnits":{
            "type":"string",
            "description":"Term duration units",
            "enum":[
                "DAYS",
                "MONTHS",
                "WEEKS",
                "YEARS"
            ]
        }
    }
}

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.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @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
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @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
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that does not exist.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @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
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @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
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @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
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Back to Top

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"
        }
    ]
}

Back to Top