--- schema_version: "1" id: 5336e3d00d8fe16c6f6c035b4af58eb37b0e144a0600812582fb69d08e289b5d title: Product Offering Price Use Cases collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/TMF620/product-offering-price-use-cases.md canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/product-offering-price-use-cases.html source_site: developer.salesforce.com content_type: documentation content_hash: 80fca1d557afbdecb0f0109d5a299cd2d42d4ba24b9a7634ccfbd7ea5e46c112 products: - Communications Cloud TM Forum API - Industries Integrations --- # Product Offering Price Use Cases | I want to
| Request Type
| Example URL
| | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Retrieve and display details of a requested product offering price. | [GET by ID](#get-by-id) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}

**NOTE:**
For invalid category ID, you will receive HTTP 404 error. | | Based on the provided field values, retrieve and display details of a particular product offering ID. | [GET by ID and Fields](#get-by-id-and-fields) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}?fields=id,name,lifecycleStatus | | List all the product offering prices present in the system. | [GET List](#get-list) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice | | List all the product offering prices present in the system
based on the provided field values. | [GET List with Fields](#get-list-with-fields) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?fields=id,name,lifecycleStatus
| | List all the product offering prices present in the inventory based on the provided field values and filter applied. | [GET List by Fields and Filtering](#get-list-by-fields-and-filtering) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?lifecycleStatus=false&fields=id,lifecycleStatus | | Limit the number of product offering prices to a maximum of specified limit and
display results from the page specified by an offset. | [GET List by limit and offset](#get-list-by-limit-and-offset) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?offset=1&limit=2
| | Create a product offering price. | [POST](#post) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice
| | Update a product offering price. | [PATCH](#patch) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}
| | Delete a product offering price. | [DELETE](#delete) | _{https://MyDomainLoginUrl}_/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}
| ### GET by ID Consider you want to retrieve details of a product offering price from the inventory. For example, product offering price ID = ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 1", "PageSize": 50, "Result": { "priceType": "One-time", "price": { "value": 10, "unit": "USD" }, "id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c", "description": "Sample description", "name": "sample name", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM", "lastUpdate": "2023-08-31T19:17:36.000+0000", "validFor": { "startDateTime": "2023-07-31T18:30:00.000+0000" }, "lifecycleStatus": "true" } } ``` ### GET by ID and Fields Consider for the product offering price ID = 6c059da5-6be5-6a8b-08f9-422beec29e55, you want to retrieve details of the `id`, `name` and `lifecycleStatus` details in the output. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/6c059da5-6be5-6a8b-08f9-422beec29e55?fields=id,name,lifecycleStatus` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 1", "PageSize": 50, "Result": { "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA", "id": "6c059da5-6be5-6a8b-08f9-422beec29e55", "name": "a3GDo0000004qzd", "lifecycleStatus": "false" } } ``` ### GET List Consider you want to retrieve details of all the product offering prices in the inventory. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 8", "PageSize": 5, "Result": [ { "priceType": "One-time", "price": { "value": 10.00000, "unit": "USD" }, "id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c", "description": "sample description", "name": "sample name", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM", "lastUpdate": "2023-08-31T19:17:36.000+0000", "validFor": { "startDateTime": "2023-07-31T18:30:00.000+0000" }, "lifecycleStatus": "true" }, { "priceType": "One-time", "price": { "value": 100.00000, "unit": "EUR" }, "id": "680c0059-8a2b-77a2-b96e-afb57b5951bf", "description": "sample description", "name": "sample name", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBBEA2", "lastUpdate": "2023-08-31T19:21:34.000+0000", "validFor": { "startDateTime": "2022-08-31T18:30:00.000+0000" }, "lifecycleStatus": "true" }, { "priceType": "One-time", "price": { "value": 1.00000, "unit": "EUR" }, "id": "72027007-33af-4272-342e-453de754bb6e", "description": "sample description", "name": "sample name", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBGEA2", "lastUpdate": "2023-08-31T19:23:33.000+0000", "validFor": { "startDateTime": "2019-09-03T18:30:00.000+0000" }, "lifecycleStatus": "true" } ] } ``` ### GET List with Fields Consider you want to retrieve all the product offering prices by applying the requested fields. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?fields=id,name,lifecycleStatus` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 2", "PageSize": 50, "Result": [ { "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA", "id": "6c059da5-6be5-6a8b-08f9-422beec29e55", "name": "sample name", "lifecycleStatus": "false" }, { "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI", "id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6", "name": "sample name", "lifecycleStatus": "false" } ] } ``` ### GET List by Fields and Filtering Consider you want to retrieve all the product offering prices by a specified filter. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?lifecycleStatus=false&fields=id,lifecycleStatus` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 2", "PageSize": 50, "Result": [ { "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA", "id": "6c059da5-6be5-6a8b-08f9-422beec29e55", "lifecycleStatus": "false" }, { "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI", "id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6", "lifecycleStatus": "false" } ] } ``` ### GET List by limit and offset Consider you want to retrieve perform the following. - Limit the number of product offering prices to a maximum of specified limit - Display results from the page specified by an offset #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?offset=1&limit=2` #### Sample Response ``` 200 OK { "PageInfo": "Page 1 of 46", "PageSize": 2, "Result": [ { "priceType": "One-time", "price": { "value": 0 }, "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA", "id": "6c059da5-6be5-6a8b-08f9-422beec29e55", "lastUpdate": "2023-07-26T05:53:58.000+0000", "name": "sample name", "lifecycleStatus": "true" }, { "priceType": "One-time", "price": { "value": 0 }, "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI", "id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6", "lastUpdate": "2023-07-26T05:53:58.000+0000", "name": "sample name", "lifecycleStatus": "true" } ] } ``` ### POST Consider you want to create a new product offering price. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/productOfferingPrice` #### Sample Request ``` { "name" : "demo pricing", "description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.", "validFor": { "startDateTime": "2020-09-22T00:00:00Z", "endDateTime": "2023-09-22T00:00:00Z" }, "lifecycleStatus": "Active", "priceType": "Recurring", "recurringChargePeriodType": "Monthly", "price": { "unit": "USD", "value": 50 }, "productOfferingTerm": [ { "name": "12 Month", "description": "12 month contract", "duration": { "amount": 12, "units": "Month" }, "validFor": { "startDateTime": "2020-09-22T16:42:23.0Z", "endDateTime": "2023-09-22T00:00:00.0Z" } } ] } ``` #### Sample Response ``` 200 OK { "productOfferingTerm": [ { "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY", "@type": "ProductOfferingTerm", "validFor": { "startDateTime": "2020-09-22T16:42:23.000+0000", "endDateTime": "2023-09-22T00:00:00.000+0000" }, "duration": { "units": "Month", "amount": 12 }, "description": "12 month contract", "name": "12 Month" } ], "lifecycleStatus": "true", "validFor": { "endDateTime": "2023-09-22T00:00:00.000+0000", "startDateTime": "2020-09-22T00:00:00.000+0000" }, "lastUpdate": "2023-09-27T08:02:09.000+0000", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2", "name": "demo pricing", "description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.", "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57", "price": { "unit": "USD", "value": 50 }, "priceType": "Recurring", "recurringChargePeriodType": "Monthly" } ``` ### PATCH Consider for the product offering price ID = 4a5dbea2-6c43-4a63-8b8a-cde4b5085c57 you want to update first level attributes and sub-resources. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/4a5dbea2-6c43-4a63-8b8a-cde4b5085c57` #### Sample Request ``` { "description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.", "name": "demo pricing", "validFor": { "startDateTime": "2020-09-22T00:00:00.000+0000", "endDateTime": "2023-09-22T00:00:00.000+0000" }, "priceType": "recurring", "priceType":"monthly", "lifecycleStatus":"false", "recurringChargePeriodType": "monthly", "price": { "unit": "USD", "value": 50 } } ``` #### Sample Response ``` { "productOfferingTerm": [ { "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY", "@type": "ProductOfferingTerm", "validFor": { "startDateTime": "2020-09-22T16:42:23.000+0000", "endDateTime": "2023-09-22T00:00:00.000+0000" }, "duration": { "units": "Month", "amount": 12 }, "description": "12 month contract", "name": "12 Month" } ], "lifecycleStatus": "true", "validFor": { "endDateTime": "2023-09-22T00:00:00.000+0000", "startDateTime": "2020-09-22T00:00:00.000+0000" }, "lastUpdate": "2023-09-27T08:02:09.000+0000", "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2", "name": "demo pricing", "description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.", "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57", "price": { "unit": "USD", "value": 50 }, "priceType": "Recurring", "recurringChargePeriodType": "Monthly" } ``` ### DELETE Consider you want to delete a product offering price ID: 3830. #### Sample URL `https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/productOffering/3830` #### Sample Response ``` 204 No content ```