TM Forum productOfferingPrice API

openapi: 3.0.1
info:
  title: Product Catalog Management agreement productOfferingPrice API
  description: "Product Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. \n### Operations\nProduct Catalog API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity\n- Manage notification of events"
  version: 5.0.0
servers:
- url: https://serverRoot/productCatalogManagement/v5/
tags:
- name: productOfferingPrice
  description: Operations for ProductOfferingPrice Resource
paths:
  /productOfferingPrice:
    get:
      tags:
      - productOfferingPrice
      summary: TM Forum List or Find ProductOfferingPrice Objects
      description: List or find ProductOfferingPrice objects
      operationId: listProductOfferingPrice
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          $ref: '#/components/responses/200ProductOfferingPriceArray'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    post:
      tags:
      - productOfferingPrice
      summary: TM Forum Creates a ProductOfferingPrice
      description: This operation creates a ProductOfferingPrice entity.
      operationId: createProductOfferingPrice
      parameters:
      - $ref: '#/components/parameters/Fields'
      requestBody:
        $ref: '#/components/requestBodies/ProductOfferingPrice_FVO'
      responses:
        '201':
          $ref: '#/components/responses/201ProductOfferingPrice'
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
  /productOfferingPrice/{id}:
    get:
      tags:
      - productOfferingPrice
      summary: TM Forum Retrieves a ProductOfferingPrice by ID
      description: This operation retrieves a ProductOfferingPrice entity. Attribute selection enabled for all first level attributes.
      operationId: retrieveProductOfferingPrice
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          $ref: '#/components/responses/200ProductOfferingPrice_Get'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    patch:
      tags:
      - productOfferingPrice
      summary: TM Forum Updates Partially a ProductOfferingPrice
      description: This operation updates partially a ProductOfferingPrice entity.
      operationId: patchProductOfferingPrice
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Fields'
      requestBody:
        $ref: '#/components/requestBodies/ProductOfferingPrice_MVO'
      responses:
        '200':
          $ref: '#/components/responses/200ProductOfferingPrice_Patch'
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    delete:
      tags:
      - productOfferingPrice
      summary: TM Forum Deletes a ProductOfferingPrice
      description: This operation deletes a ProductOfferingPrice entity.
      operationId: deleteProductOfferingPrice
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '202':
          $ref: '#/components/responses/202'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
components:
  examples:
    Product_Offering_Price_Update_Patch_Merge_example_request:
      value:
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        '@type': ProductOfferingPrice
      description: Here is an example of a request for updating a product offering price.
    ProductOfferingPrice_retrieve_example_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-09-22T00:00:00Z'
          endDateTime: '2021-09-22T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: Here is an example of a request for retrieving a specific price.
    Product_Offering_Price_Update_Patch_Merge_example_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: Here is an example of a response for updating a product offering price using JSON Patch.
    Product_Offering_Price_Update_Implicit_Merge_example_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: Here is an example of a response for updating a product offering price using JSON Patch.
    Product_Offering_Price_Create_example_request:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '1.0'
        validFor:
          startDateTime: '2020-09-22T00:00:00Z'
          endDateTime: '2021-09-22T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: Here is an example of a request for creating a product offering price.
    Product_Offering_Price_Update_JSON_Patch_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        - id: '2807'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2807
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: The updated product offering price with geographic area
    Product_Offering_Price_Update_JSON_Patch_request:
      value:
      - op: add
        path: /place
        value:
          id: '2807'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2807
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
      description: Here is an example of a request for updating a product offering price by adding a geographic area.
    Product_Offering_Price_Update_JSON_Patch_Query_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: The updated product offering price with removed geographic area
    Product_Offering_Price_Update_JSON_Patch_Query_request:
      value:
      - op: remove
        path: /place?id=2807
      description: Here is an example of a request for updating a product offering price by removing a specific geographic area.
    Product_Offering_Price_Update_Implicit_Merge_example_request:
      value:
        version: '2.0'
        validFor:
          startDateTime: '2020-11-06T00:00:00Z'
          endDateTime: '2021-11-06T00:00:00Z'
        '@type': ProductOfferingPrice
      description: Here is an example of a request for updating a product offering price.
    ProductOfferingPrice_list_example_response:
      value:
      - id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '2.0'
        validFor:
          startDateTime: '2020-09-22T00:00:00Z'
          endDateTime: '2021-09-22T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      - id: '1741'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
        name: discount for Business Firewall
        description: This pricing describes the discount for a firewall service that can be deployed in business customer premise.
        version: '1.0'
        validFor:
          startDateTime: '2020-09-22T00:00:00Z'
          endDateTime: '2021-09-22T00:00:00Z'
        priceType: discount
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-11-24T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        applicationDuration:
          amount: 12
          units: Month
        price: {}
        percentage: 10
        priority: 1
        productOfferingTerm: []
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm: []
        tax: []
        popRelationship:
        - id: '2027'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/2027
          relationshipType: relyOn
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: discountInstance
          '@referredType': ProductOfferingPriceAlterationTemplate
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPriceAlteration
      description: Here is an example of a request for retrieving multiple prices.
    Product_Offering_Price_Create_example_response:
      value:
        id: '1747'
        href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1747
        name: Recurring Charge for Business Firewall
        description: This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.
        version: '1.0'
        validFor:
          startDateTime: '2020-09-22T00:00:00Z'
          endDateTime: '2021-09-22T00:00:00Z'
        priceType: recurring
        recurringChargePeriodType: monthly
        recurringChargePeriodLength: 1
        lastUpdate: '2020-09-23T00:00:00Z'
        isBundle: false
        lifecycleStatus: Active
        unitOfMeasure:
          amount: 1
          units: Month
        price:
          unit: EUR
          value: 50
        percentage: 0
        productOfferingTerm:
        - name: 12 Month
          description: 12 month contract
          duration:
            amount: 12
            units: Month
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': ProductOfferingTerm
        place:
        - id: '2707'
          href: https://mycsp.com:8080/tmf-api/geographicAddressManagement/v5/geographicAddress/2707
          name: San Francisco Bay Area
          '@referredType': GeographicAddress
          '@type': PlaceRef
        policy:
        - '@referredType': Policy
          name: PriceRuleNo1
          id: '2503'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/policy/2503
          '@type': PolicyRef
        pricingLogicAlgorithm:
        - id: '2777'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/PricingLogicAlgorithm/2777
          name: RecurringRatingPLA
          description: Algorithm that rates Recurring event
          plaSpecId: '2801'
          validFor:
            startDateTime: '2020-09-22T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          '@type': PricingLogicAlgorithm
        tax:
        - taxAmount:
            unit: EUR
            value: 10
          taxCategory: VAT
          taxRate: 20
          '@type': TaxItem
        popRelationship:
        - id: '1741'
          href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/productOfferingPrice/1741
          relationshipType: discountedBy
          validFor:
            startDateTime: '2020-09-23T16:42:23Z'
            endDateTime: '2021-09-22T00:00:00Z'
          role: A-Charge
          '@referredType': ProductOfferingPriceAlteration
          '@type': ProductOfferingPriceRelationship
        '@type': ProductOfferingPrice
      description: Here is an example of a response for creating a product offering price.
  schemas:
    EntityRef_FVO:
      allOf:
      - $ref: '#/components/schemas/Extensible_FVO'
      - $ref: '#/components/schemas/Addressable_FVO'
      - type: object
        description: Entity reference schema to be use for all entityRef class.
        properties:
          id:
            type: string
            description: The identifier of the referred entity.
          href:
            type: string
            description: The URI of the referred entity.
          name:
            type: string
            description: Name of the referred entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
        required:
        - id
    PlaceRef:
      type: object
      description: Place reference.


# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/openapi/tm-forum-productofferingprice-api-openapi.yml