1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Product Offering Prices

Get all product offering prices

get

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

Returns a list of product offering prices that match the search criteria.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of product offering prices was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
  • ProductOfferingPrice_Schemas
    Title: ProductOfferingPrice_Schemas
    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", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle" } }
    The product offering price resource.
Nested Schema : ProductOfferingPrice_Schemas
Type: object
Title: ProductOfferingPrice_Schemas
Discriminator: @type

Discriminator Values

The product offering price resource.
Match One Schema
Show Source
Nested Schema : ProductOfferingPriceOracle
Title: ProductOfferingPriceOracle
Match All
Show Source
  • 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", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
    The product offering price resource.
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
Nested Schema : ProductOfferingPriceAlterationOracle
Title: ProductOfferingPriceAlterationOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceAllowanceOracle
Title: ProductOfferingPriceAllowanceOracle
Match All
Show Source
Nested Schema : ProductOfferRolloverPriceOracle
Title: ProductOfferRolloverPriceOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceCounterOracle
Title: ProductOfferingPriceCounterOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceOverageOracle
Title: ProductOfferingPriceOverageOracle
Match All
Show Source
Nested Schema : ProductOfferingPricePlanOracle
Title: ProductOfferingPricePlanOracle
Match All
Show Source
Nested Schema : PenaltyPriceOracle
Title: PenaltyPriceOracle
Match All
Show Source
Nested Schema : ProductOfferingBeatPriceOracle
Title: ProductOfferingBeatPriceOracle
Match All
Show Source
Nested Schema : ProductOfferingPrice
Type: object
Title: ProductOfferingPrice
Discriminator: @type

Discriminator Values

The product offering price resource.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : ProductOfferingPriceAlterationOracle-allOf[1]
Type: object
Show Source
Nested Schema : PriceEligibilityOracle
Type: object
Title: PriceEligibilityOracle
Specifies the eligibility rule for the offer.
Show Source
Nested Schema : eligibilityExpression
Type: array
A list of eligibility expressions associated with the price eligibility.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : EligibilityExpressionOracle
Type: object
Title: EligibilityExpressionOracle
The eligibility expression resource.
Show Source
Nested Schema : expressionRelationship
Type: array
A list of expression relationships associated with the eligibility expression.
Show Source
Nested Schema : value
A discrete value that the relationship can take on.
Match One Schema
Show Source
Nested Schema : ExpressionRelationship
Type: object
Title: ExpressionRelationship
The expression relationship resource.
Show Source
Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]
Type: object
Show Source
Nested Schema : AllowanceValidityOracle
Type: object
Title: AllowanceValidityOracle
The validity of allowance.
Show Source
  • Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]
    Indicates start criteria of allowance validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE.
  • Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]
    Indicates the unit of allowance validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE.
  • The value assigned to the product offering price allowance.
Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]
Type: object
Show Source
Nested Schema : rolloverRules
Type: array
A list of rollover rules associated with the product offer rollover price.
Show Source
Nested Schema : RolloverRuleOracle
Type: object
Title: RolloverRuleOracle
The rollover rule resource.
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
The balance element ref in price.
Show Source
Nested Schema : MaximumRolloverCycleOracle
Type: object
Title: MaximumRolloverCycleOracle
Indicates the maximum allowed rollover cycles and the unit.
Show Source
Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]
Type: object
Show Source
Nested Schema : CounterValidityOracle
Type: object
Title: CounterValidityOracle
The validity of counter.
Show Source
  • Allowed Values: [ "EVENT_OCCURRENCE", "FIRST_USAGE" ]
    Indicates start criteria of counter validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE.
  • Allowed Values: [ "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "ACCOUNTING_CYCLE", "BILLING_CYCLE" ]
    Indicates the unit of counter validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE.
  • The value assigned to the product offering price counter.
Nested Schema : ProductOfferingPriceOverageOracle-allOf[1]
Type: object
Nested Schema : ProductOfferingPricePlanOracle-allOf[1]
Type: object
Show Source
Nested Schema : compositePopRelationship
Type: array
A list of composite pop relationships associated with the product offering price plan.
Show Source
Nested Schema : usageSpecMeteringRuleUse
Type: array
A list of usage specification metering rule uses associated with the product offering price plan.
Show Source
Nested Schema : CompositePopRelationshipOracle
Type: object
Title: CompositePopRelationshipOracle
The composite relationship from a parent product offering price to a child product offering price.
Show Source
Nested Schema : UsageSpecMeteringRuleUse
Type: object
Title: UsageSpecMeteringRuleUse
The metering rules used in the usage price plan.
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : PenaltyPriceOracle-allOf[1]
Type: object
Show Source
Nested Schema : prorationReductionTerm
Type: array
A list of proration reduction terms associated with the penalty price.
Show Source
  • 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.
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
Nested Schema : ProductOfferingBeatPriceOracle-allOf[1]
Type: object
Show Source
Nested Schema : BeatOracle
Type: object
Title: BeatOracle
The beat is basically the pulse measure used for charging usage quantity.
Show Source
  • The usage quantity increment of the beat.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit of measure for the incrementQuantity of beat.
  • The minimum usage quantity of the beat.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit of measure for the minQuantity of beat.
  • Allowed Values: [ "DOWN", "DOWN_ALT", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]
    The rounding strategy applied to beat usage quantities. Valid values are DOWN, DOWN_ALT, FLOOR, FLOOR_ALT, NEAREST, and UP.

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

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
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source
Back to Top

Examples

The following example shows how to get a category by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice \ -H 'Content-Type: application/json'

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",
    "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-09-03T00: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"
        }
    ]
},
{
    "id": "POP-HS-OTF2",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/POP-HS-OTF2",
    "name": "Hotspot One Time Fee 2",
    "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-09-03T00: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