Order Item Usage Details (GET)

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

Here are the details 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.

This API doesn’t return binding target rates. Use the Binding Object Usage Details API to retrieve binding target rates.

Resource

1/commerce/sales-orders/line-items/{orderItemId}/usage-details

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/sales-orders/line-items/{802SG000003vZ15YAE}/usage-details

1https://{yourInstance}.salesforce.com/services/data/v68.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. OrderItemRateCardEntry; or OrderItemRateAdjustment.	Optional	63.0

Response Body for GET

Usage Details