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

Get a product offering price

get

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

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ProductOfferingPrice_Schemas
Type: object
Title: ProductOfferingPrice_Schemas
Discriminator: @type

Discriminator Values

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", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
  • 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" } }
Nested Schema : ProductOfferingPriceAlterationOracle
Title: ProductOfferingPriceAlterationOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceCounterOracle
Title: ProductOfferingPriceCounterOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceAllowanceOracle
Title: ProductOfferingPriceAllowanceOracle
Match All
Show Source
Nested Schema : ProductOfferRolloverPriceOracle
Title: ProductOfferRolloverPriceOracle
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 : ProductOfferingPrice
Type: object
Title: ProductOfferingPrice
Discriminator: @type

Discriminator Values

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
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : EligibilityExpressionOracle
Type: object
Title: EligibilityExpressionOracle
A eligibility expression
Show Source
Nested Schema : expressionRelationship
Type: array
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
An expression relationship
Show Source
Nested Schema : ProductOfferingPriceCounterOracle-allOf[1]
Type: object
Show Source
Nested Schema : CounterValidityOracle
Type: object
Title: CounterValidityOracle
Validity of counter
Show Source
Nested Schema : ProductOfferingPriceAllowanceOracle-allOf[1]
Type: object
Show Source
Nested Schema : AllowanceValidityOracle
Type: object
Title: AllowanceValidityOracle
Validity of allowance
Show Source
Nested Schema : ProductOfferRolloverPriceOracle-allOf[1]
Type: object
Show Source
Nested Schema : rolloverRules
Type: array
Show Source
Nested Schema : RolloverRuleOracle
Type: object
Title: RolloverRuleOracle
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
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 : ProductOfferingPriceOverageOracle-allOf[1]
Type: object
Nested Schema : ProductOfferingPricePlanOracle-allOf[1]
Type: object
Show Source
Nested Schema : compositePopRelationship
Type: array
Show Source
Nested Schema : usageSpecMeteringRuleUse
Type: array
Show Source
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
Nested Schema : UsageSpecMeteringRuleUse
Type: object
Title: UsageSpecMeteringRuleUse
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" } }
    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

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

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

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

404 Response

Your request includes a resource URI that does not exist.
Body ()
Root Schema : Error
Type: object
Title: Error
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
Show Source

500 Response

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

Examples

The following example shows how to get a product offering price 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/POP-2264407618-1594103819620 \ -H 'Content-Type: application/json'

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-2264407618-1594103819620",
    "id": "POP-2264407618-1594103819620",
    "lastUpdate": "2020-07-07T06:38:03.63Z",
    "version": "1.0",
    "isBundle": true,
    "@type": "ProductOfferingPriceOracle",
    "lifecycleStatus": "In design",
    "name": "PRICEf9aa766f4d9b4d75a5114cae2062ae78",
    "bundledPopRelationship": [
        {
            "id": "POP-1949444329-1594054571327",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-1949444329-1594054571327",
            "name": "Purchase fee",
            "@type": "ProductOfferingPriceOracle",
            "lifecycleStatus": "In design"
        },
        {
            "id": "DiscountPOP-2972209452-1594103819619",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/DiscountPOP-2972209452-1594103819619",
            "name": "DiscountPOP-2972209452-1594103819619",
            "@type": "ProductOfferPriceAlterationOracle",
            "lifecycleStatus": "In design"
        }
    ]
}
Back to Top