Usage Details
Output representation of the usage details of a quote, an order, or an asset.
- JSON example
- This sample response shows resources that include grants, if applicable, and resources
without rates when you retrieve the usage details of an order
item.
{ "records": [ { "bindingInstanceTargetType": null, "bindingInstanceType": null, "chargeForOverages": "Yes", "fields": {}, "name": "API Calls", "negotiable": ",", "negotiatedRate": null, "negotiatedRateCardEntryId": ",", "quantity": 1000.0, "rate": null, "rateAdjustments": [], "rateCardEntryId": ",", "rateUnitOfMeasureName": "USD", "unitOfMeasure": null } ] }
- This example shows a sample response without negotiated rates when you retrieve the
usage details of an order item.
{ "records": [ { "bindingInstanceTargetType": "Product", "bindingInstanceType": "Target", "chargeForOverages": "Yes", "fields": {} "name": "Paddle Board", "negotiable": "Negotiable,Non-Negotiable", "negotiatedRate": null, "negotiatedRateCardEntryId": ",", "quantity": 15.0, "rate": 5.0, "rateAdjustments": [ { "fields": {}, "lowerBound": 0.0, "name": null, "negotiatedRateAdjustmentId": null, "rateAdjustmentId": "1ENxx0000004C9BGAU", "rateAdjustmentType": "Percentage", "rateAdjustmentValue": 10.0, "tierUnitOfMeasure": "USD", "upperBound": 50.0 } ], "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU", "rateUnitOfMeasureName": "USD", "unitOfMeasure": "GB" } ] }
- This sample response shows negotiated rates when you retrieve the usage details of an
order item. The negotiated rates are derived from these objects for assets,
order items, or quote line items.
- AssetRateCardEntry
- AssetRateAdjustment
- OrderItemRateCardEntry
- OrderItemRateAdjustment
- QuoteLineRateCardEntry
- QuoteLineRateAdjustment
{ "records": [ { "bindingInstanceTargetType": "Product", "bindingInstanceType": "Target", "chargeForOverages": "Yes", "fields": {}, "name": "Paddle Board", "negotiable": "Negotiable,Non-Negotiable", "negotiatedRate": 20.0, "negotiatedRateCardEntryId": "1ELxx0000004C9JGAU,1ELxx0000004C9KGAU", "quantity": 15.0, "rate": 5.0, "rateAdjustments": [ { "fields": {}, "lowerBound": 0.0, "name": "Tier 1", "negotiatedRateAdjustmentId": "1ENxx0000004C9BGAU", "rateAdjustmentId": "1ENxx0000004C9BGAU", "rateAdjustmentType": "Percentage", "rateAdjustmentValue": 10.0, "tierUnitOfMeasure": "USD", "upperBound": 50.0 } ], "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU", "rateUnitOfMeasureName": "USD", "unitOfMeasure": "GB" } ] }
- This sample response shows details of the custom fields when you retrieve the usage
details of an order item.
{ "records": [ { "fields": { "MyCustomDate__c": { "displayValue": "2024-09-24", "value": "2024-09-24T17:46:30.662Z" }, "MyCustomNumber__c": { "displayValue": "20.0", "value": 20 } }, "bindingInstanceTargetType": "Product", "bindingInstanceType": "Target", "chargeForOverages": "Yes", "name": "Massage Therapy", "negotiable": "Negotiable,Non-Negotiable", "negotiatedRate": 20.0, "negotiatedRateCardEntryId": "1ELxx0000004C9JGAU,1ELxx0000004C9KGAU", "quantity": 15.0, "rate": 5.0, "rateAdjustments": [ { "fields": { "MyCustomString__c": { "displayValue": "My Custom String", "value": "MyCustomString" } }, "lowerBound": 0.0, "name": "Tier 1", "negotiatedRateAdjustmentId": "1ENxx0000004C9BGAU", "rateAdjustmentId": "1ENxx0000004C9BGAU", "rateAdjustmentType": "Percentage", "rateAdjustmentValue": 10.0, "tierUnitOfMeasure": "USD", "upperBound": 50.0 } ], "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU", "rateUnitOfMeasureName": "USD", "unitOfMeasure": "GB" } ] }
- This sample response shows values for the type and target type of a binding
instance if the BindingInstanceTargetId
value is available in the QuoteLineItem, OrderItem, and AssetStatePeriod
objects. Additionally, the rate, negotiated rates, and rate card entry
values show the associated details of the binding
object.
{ "records": [ { "bindingInstanceTargetType": "Account", "bindingInstanceType": "Target", "chargeForOverages": "Yes", "fields": {}, "name": "Data Transfers", "negotiable": "Non-Negotiable,Non-Negotiable", "negotiatedRate": null, "negotiatedRateCardEntryId": "1QNxx0000004CQmGAM,1QNxx0000004CLwGAM", "quantity": 250, "rate": 0.098765, "rateAdjustments": [ { "fields": {}, "lowerBound": 0, "name": null, "negotiatedRateAdjustmentId": null, "rateAdjustmentId": "1Soxx0000004CAeCAM", "rateAdjustmentType": "Percentage", "rateAdjustmentValue": 0, "tierUnitOfMeasure": "USD", "upperBound": 121 } ], "rateCardEntryId": "1CJxx0000004C9CGAU,1CJxx0000004C9GGAU", "rateUnitOfMeasureName": "USD", "unitOfMeasure": "GB" } ] }
Property Name | Type | Description | Filter Group and Version | Available Version |
---|---|---|---|---|
errors | Usage Detail Error Response[] | List of errors. | Small, 63.0 | 63.0 |
records | Rate Card Entry[] | List of rate card entry records. | Small, 63.0 | 63.0 |