REST API Services for Oracle CPQ

Get Charge Defintion

get

/rest/v16/pricingSetup/chargeDefinitions/{code}

Use this endpoint to retrieve the specified pricing charge definition.

Request

Path Parameters

code(required): string

Query Parameters

fields: string

This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.

Response

Supported Media Types

application/json

200 Response

Success

Examples

The following example shows how to retrieve the specified pricing Charge Definition by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/chargeDefinitions/usage_callCharge_c

Response Body Sample

{
  "code": "usage_callCharge_c",
  "name": "Usage Call Charge",
  "description": "Generated Charge Definition",
  "chargeType": "Call Charge",
  "chargeTypeCode": "callCharge_c",
  "priceType": "Usage",
  "priceTypeCode": "Usage",
  "dateAdded": "2023-08-29T19:35:18Z",
  "dateModified": "2023-08-29T19:35:18Z",
  "type": "Custom Definition",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/pricingSetup/chargeDefinitions/usage_callCharge_c"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/pricingSetup/chargeDefinitions"
    }
  ],
  "active": true
}