Order Item Usage Details (GET)

Get details of a usage-based product associated with an order item.

Here are the details of the information that this API returns:

  • Grants and resources for the product, if rates aren’t configured.
  • Grants, resources, and any configured rates for the product. The rates are returned by the Rate Plan (GET) API.
  • Resources that include grants, if applicable, and any negotiated rates for the product in case of a rate override request.
Resource
/commerce/sales-orders/line-items/orderItemId/usage-details
Resource example
https://yourInstance.salesforce.com/services/data/v64.0/commerce/sales-orders/line-items/802SG000003vZ15YAE/usage-details
https://yourInstance.salesforce.com/services/data​/v64.0/commerce/sales-orders/line-items/802SG000003vZ15YAE/usage-details?optionalFields=OrderItemRateCardEntry.MyCustomDate__c,OrderItemRateCardEntry.MyCustomNumber__c,OrderItemRateAdjustment.myCustomString__c
Available version
63.0
HTTP methods
GET
Path parameter for GET
Parameter Name Type Description Required or Optional Available Version
orderItemId String ID of the order item. Required 63.0
Query parameters for GET
Parameter Name Type Description Required or Optional Available Version
effectiveDate String Date that's used to search for the applicable rate card entries. Optional 63.0
optionalFields String[] Custom fields that you can use to query these objects. Optional 63.0
Response body for GET
Usage Details