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.

1{
2  "records": [
3    {
4      "bindingInstanceTargetType": null,
5      "bindingInstanceType": null,
6      "chargeForOverages": "Yes",
7      "isOptional": false,
8      "fields": {},
9      "name": "API Calls",
10      "negotiable": ",",
11      "negotiatedRate": null,
12      "negotiatedRateCardEntryId": ",",
13      "quantity": 1000,
14      "rate": null,
15      "rateAdjustments": [],
16      "rateCardEntryId": ",",
17      "rateUnitOfMeasureName": "USD",
18      "unitOfMeasure": null,
19      "usageResourceGrantAndPolicyDetail": {
20        "grantDetail": {
21          "grantType": "Grant",
22          "id": "1BXxx0000004C9lGAE",
23          "quantity": 100,
24          "usageGrantNegotiable": "Negotiable",
25          "usageRefreshPolicy": {
26            "id": "1BYxx0000004C92GAE",
27            "negotiable": "Non-Negotiable"
28          },
29          "usageRolloverPolicy": {
30            "id": "1BVxx0000004C93GAE",
31            "negotiable": "Non-Negotiable"
32          },
33          "validityPeriodTerm": 1,
34          "validityPeriodUnit": "Month"
35        },
36        "negotiatedGrantDetail": {
37          "grantType": "Grant",
38          "id": "1X6xx00000000OECAY",
39          "quantity": 100,
40          "usageGrantNegotiable": "Negotiable",
41          "usageRefreshPolicy": {
42            "id": "1BYxx0000004C92GAE",
43            "negotiable": "Non-Negotiable"
44          },
45          "usageRolloverPolicy": {
46            "id": "1BVxx0000004C93GAE",
47            "negotiable": "Non-Negotiable"
48          },
49          "validityPeriodTerm": 1,
50          "validityPeriodUnit": "Month"
51        },
52        "negotiatedResourcePolicyDetail": {
53          "id": "1X5xx00000000OECAY",
54          "ratingFrequencyPolicy": {
55            "id": null,
56            "negotiable": null
57          },
58          "usageAggregationPolicy": {
59            "id": null,
60            "negotiable": null
61          },
62          "usageCommitmentPolicy": {
63            "id": "7Pexx0000004C92CAE",
64            "negotiable": "Non-Negotiable"
65          },
66          "usageOveragePolicy": {
67            "id": null,
68            "negotiable": null
69          }
70        },
71        "resourcePolicyDetail": {
72          "id": "7Suxx0000004C9kCAE",
73          "ratingFrequencyPolicy": {
74            "id": null,
75            "negotiable": null
76          },
77          "usageAggregationPolicy": {
78            "id": null,
79            "negotiable": null
80          },
81          "usageCommitmentPolicy": {
82            "id": "7Pexx0000004C92CAE",
83            "negotiable": "Non-Negotiable"
84          },
85          "usageOveragePolicy": {
86            "id": null,
87            "negotiable": null
88          }
89        }
90      },
91      "usageResourceId": "1BRxx0000004C9CGAU"
92    }
93  ]
94}

This example shows a sample response without negotiated rates when you retrieve the usage details of an order item.

1{
2  "records": [
3    {
4      "bindingInstanceTargetType": "Product",
5      "bindingInstanceType": "Target",
6      "chargeForOverages": "Yes",
7      "isOptional": false,
8      "fields": {},
9      "name": "Paddle Board",
10      "negotiable": "Negotiable,Non-Negotiable",
11      "negotiatedRate": null,
12      "negotiatedRateCardEntryId": ",",
13      "quantity": 15,
14      "rate": 5,
15      "rateAdjustments": [
16        {
17          "fields": {},
18          "lowerBound": 0,
19          "name": null,
20          "negotiatedRateAdjustmentId": null,
21          "rateAdjustmentId": "1ENxx0000004C9BGAU",
22          "rateAdjustmentType": "Percentage",
23          "rateAdjustmentValue": 10,
24          "tierUnitOfMeasure": "USD",
25          "upperBound": 50
26        }
27      ],
28      "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU",
29      "rateUnitOfMeasureName": "USD",
30      "unitOfMeasure": "GB",
31      "usageResourceGrantAndPolicyDetail": {
32        "grantDetail": {
33          "grantType": "Grant",
34          "id": "1BXxx0000004C9lGAE",
35          "quantity": 100,
36          "usageGrantNegotiable": "Negotiable",
37          "usageRefreshPolicy": {
38            "id": "1BYxx0000004C92GAE",
39            "negotiable": "Non-Negotiable"
40          },
41          "usageRolloverPolicy": {
42            "id": "1BVxx0000004C93GAE",
43            "negotiable": "Non-Negotiable"
44          },
45          "validityPeriodTerm": 1,
46          "validityPeriodUnit": "Month"
47        },
48        "negotiatedGrantDetail": {
49          "grantType": "Grant",
50          "id": "1X6xx00000000OECAY",
51          "quantity": 100,
52          "usageGrantNegotiable": "Negotiable",
53          "usageRefreshPolicy": {
54            "id": "1BYxx0000004C92GAE",
55            "negotiable": "Non-Negotiable"
56          },
57          "usageRolloverPolicy": {
58            "id": "1BVxx0000004C93GAE",
59            "negotiable": "Non-Negotiable"
60          },
61          "validityPeriodTerm": 1,
62          "validityPeriodUnit": "Month"
63        },
64        "negotiatedResourcePolicyDetail": {
65          "id": "1X5xx00000000OECAY",
66          "ratingFrequencyPolicy": {
67            "id": null,
68            "negotiable": null
69          },
70          "usageAggregationPolicy": {
71            "id": null,
72            "negotiable": null
73          },
74          "usageCommitmentPolicy": {
75            "id": "7Pexx0000004C92CAE",
76            "negotiable": "Non-Negotiable"
77          },
78          "usageOveragePolicy": {
79            "id": null,
80            "negotiable": null
81          }
82        },
83        "resourcePolicyDetail": {
84          "id": "7Suxx0000004C9kCAE",
85          "ratingFrequencyPolicy": {
86            "id": null,
87            "negotiable": null
88          },
89          "usageAggregationPolicy": {
90            "id": null,
91            "negotiable": null
92          },
93          "usageCommitmentPolicy": {
94            "id": "7Pexx0000004C92CAE",
95            "negotiable": "Non-Negotiable"
96          },
97          "usageOveragePolicy": {
98            "id": null,
99            "negotiable": null
100          }
101        }
102      },
103      "usageResourceId": "1BRxx0000004C9CGAU"
104    }
105  ]
106}

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

1{
2  "records": [
3    {
4      "bindingInstanceTargetType": "Product",
5      "bindingInstanceType": "Target",
6      "chargeForOverages": "Yes",
7      "isOptional": false,
8      "fields": {},
9      "name": "Paddle Board",
10      "negotiable": "Negotiable,Non-Negotiable",
11      "negotiatedRate": 20,
12      "negotiatedRateCardEntryId": "1ELxx0000004C9JGAU,1ELxx0000004C9KGAU",
13      "quantity": 15,
14      "rate": 5,
15      "rateAdjustments": [
16        {
17          "fields": {},
18          "lowerBound": 0,
19          "name": "Tier 1",
20          "negotiatedRateAdjustmentId": "1ENxx0000004C9BGAU",
21          "rateAdjustmentId": "1ENxx0000004C9BGAU",
22          "rateAdjustmentType": "Percentage",
23          "rateAdjustmentValue": 10,
24          "tierUnitOfMeasure": "USD",
25          "upperBound": 50
26        }
27      ],
28      "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU",
29      "rateUnitOfMeasureName": "USD",
30      "unitOfMeasure": "GB",
31      "usageResourceGrantAndPolicyDetail": {
32        "grantDetail": {
33          "grantType": "Grant",
34          "id": "1BXxx0000004C9lGAE",
35          "quantity": 100,
36          "usageGrantNegotiable": "Negotiable",
37          "usageRefreshPolicy": {
38            "id": "1BYxx0000004C92GAE",
39            "negotiable": "Non-Negotiable"
40          },
41          "usageRolloverPolicy": {
42            "id": "1BVxx0000004C93GAE",
43            "negotiable": "Non-Negotiable"
44          },
45          "validityPeriodTerm": 1,
46          "validityPeriodUnit": "Month"
47        },
48        "negotiatedGrantDetail": {
49          "grantType": "Grant",
50          "id": "1X6xx00000000OECAY",
51          "quantity": 100,
52          "usageGrantNegotiable": "Negotiable",
53          "usageRefreshPolicy": {
54            "id": "1BYxx0000004C92GAE",
55            "negotiable": "Non-Negotiable"
56          },
57          "usageRolloverPolicy": {
58            "id": "1BVxx0000004C93GAE",
59            "negotiable": "Non-Negotiable"
60          },
61          "validityPeriodTerm": 1,
62          "validityPeriodUnit": "Month"
63        },
64        "negotiatedResourcePolicyDetail": {
65          "id": "1X5xx00000000OECAY",
66          "ratingFrequencyPolicy": {
67            "id": null,
68            "negotiable": null
69          },
70          "usageAggregationPolicy": {
71            "id": null,
72            "negotiable": null
73          },
74          "usageCommitmentPolicy": {
75            "id": "7Pexx0000004C92CAE",
76            "negotiable": "Non-Negotiable"
77          },
78          "usageOveragePolicy": {
79            "id": null,
80            "negotiable": null
81          }
82        },
83        "resourcePolicyDetail": {
84          "id": "7Suxx0000004C9kCAE",
85          "ratingFrequencyPolicy": {
86            "id": null,
87            "negotiable": null
88          },
89          "usageAggregationPolicy": {
90            "id": null,
91            "negotiable": null
92          },
93          "usageCommitmentPolicy": {
94            "id": "7Pexx0000004C92CAE",
95            "negotiable": "Non-Negotiable"
96          },
97          "usageOveragePolicy": {
98            "id": null,
99            "negotiable": null
100          }
101        }
102      },
103      "usageResourceId": "1BRxx0000004C9CGAU"
104    }
105  ]
106}

This sample response shows details of the custom fields when you retrieve the usage details of an order item.

1{
2  "records": [
3    {
4      "fields": {
5        "MyCustomDate__c": {
6          "displayValue": "2024-09-24",
7          "value": "2024-09-24T17:46:30.662Z"
8        },
9        "MyCustomNumber__c": {
10          "displayValue": "20.0",
11          "value": 20
12        }
13      },
14      "isOptional": false,
15      "bindingInstanceTargetType": "Product",
16      "bindingInstanceType": "Target",
17      "chargeForOverages": "Yes",
18      "name": "Therapy",
19      "negotiable": "Negotiable,Non-Negotiable",
20      "negotiatedRate": 20,
21      "negotiatedRateCardEntryId": "1ELxx0000004C9JGAU,1ELxx0000004C9KGAU",
22      "quantity": 15,
23      "rate": 5,
24      "rateAdjustments": [
25        {
26          "fields": {
27            "MyCustomString__c": {
28              "displayValue": "My Custom String",
29              "value": "MyCustomString"
30            }
31          },
32          "lowerBound": 0,
33          "name": "Tier 1",
34          "negotiatedRateAdjustmentId": "1ENxx0000004C9BGAU",
35          "rateAdjustmentId": "1ENxx0000004C9BGAU",
36          "rateAdjustmentType": "Percentage",
37          "rateAdjustmentValue": 10,
38          "tierUnitOfMeasure": "USD",
39          "upperBound": 50
40        }
41      ],
42      "rateCardEntryId": "1CJxx0000004C9IGAU,1CJxx0000004C9JGAU",
43      "rateUnitOfMeasureName": "USD",
44      "unitOfMeasure": "GB",
45      "usageResourceGrantAndPolicyDetail": {
46        "grantDetail": {
47          "grantType": "Grant",
48          "id": "1BXxx0000004C9lGAE",
49          "quantity": 100,
50          "usageGrantNegotiable": "Negotiable",
51          "usageRefreshPolicy": {
52            "id": "1BYxx0000004C92GAE",
53            "negotiable": "Non-Negotiable"
54          },
55          "usageRolloverPolicy": {
56            "id": "1BVxx0000004C93GAE",
57            "negotiable": "Non-Negotiable"
58          },
59          "validityPeriodTerm": 1,
60          "validityPeriodUnit": "Month"
61        },
62        "negotiatedGrantDetail": {
63          "grantType": "Grant",
64          "id": "1X6xx00000000OECAY",
65          "quantity": 100,
66          "usageGrantNegotiable": "Negotiable",
67          "usageRefreshPolicy": {
68            "id": "1BYxx0000004C92GAE",
69            "negotiable": "Non-Negotiable"
70          },
71          "usageRolloverPolicy": {
72            "id": "1BVxx0000004C93GAE",
73            "negotiable": "Non-Negotiable"
74          },
75          "validityPeriodTerm": 1,
76          "validityPeriodUnit": "Month"
77        },
78        "negotiatedResourcePolicyDetail": {
79          "id": "1X5xx00000000OECAY",
80          "ratingFrequencyPolicy": {
81            "id": null,
82            "negotiable": null
83          },
84          "usageAggregationPolicy": {
85            "id": null,
86            "negotiable": null
87          },
88          "usageCommitmentPolicy": {
89            "id": "7Pexx0000004C92CAE",
90            "negotiable": "Non-Negotiable"
91          },
92          "usageOveragePolicy": {
93            "id": null,
94            "negotiable": null
95          }
96        },
97        "resourcePolicyDetail": {
98          "id": "7Suxx0000004C9kCAE",
99          "ratingFrequencyPolicy": {
100            "id": null,
101            "negotiable": null
102          },
103          "usageAggregationPolicy": {
104            "id": null,
105            "negotiable": null
106          },
107          "usageCommitmentPolicy": {
108            "id": "7Pexx0000004C92CAE",
109            "negotiable": "Non-Negotiable"
110          },
111          "usageOveragePolicy": {
112            "id": null,
113            "negotiable": null
114          }
115        }
116      },
117      "usageResourceId": "1BRxx0000004C9CGAU"
118    }
119  ]
120}

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.

1{
2  "records": [
3    {
4      "bindingInstanceTargetType": "Account",
5      "bindingInstanceType": "Target",
6      "chargeForOverages": "Yes",
7      "fields": {},
8      "isOptional": false,
9      "name": "Data Transfers",
10      "negotiable": "Non-Negotiable,Non-Negotiable",
11      "negotiatedRate": null,
12      "negotiatedRateCardEntryId": "1QNxx0000004CQmGAM,1QNxx0000004CLwGAM",
13      "quantity": 250,
14      "rate": 0.098765,
15      "rateAdjustments": [
16        {
17          "fields": {},
18          "lowerBound": 0,
19          "name": null,
20          "negotiatedRateAdjustmentId": null,
21          "rateAdjustmentId": "1Soxx0000004CAeCAM",
22          "rateAdjustmentType": "Percentage",
23          "rateAdjustmentValue": 0,
24          "tierUnitOfMeasure": "USD",
25          "upperBound": 121
26        }
27      ],
28      "rateCardEntryId": "1CJxx0000004C9CGAU,1CJxx0000004C9GGAU",
29      "rateUnitOfMeasureName": "USD",
30      "unitOfMeasure": "GB",
31      "usageResourceGrantAndPolicyDetail": {
32        "grantDetail": {
33          "grantType": "Grant",
34          "id": "1BXxx0000004C9lGAE",
35          "quantity": 100,
36          "usageGrantNegotiable": "Negotiable",
37          "usageRefreshPolicy": {
38            "id": "1BYxx0000004C92GAE",
39            "negotiable": "Non-Negotiable"
40          },
41          "usageRolloverPolicy": {
42            "id": "1BVxx0000004C93GAE",
43            "negotiable": "Non-Negotiable"
44          },
45          "validityPeriodTerm": 1,
46          "validityPeriodUnit": "Month"
47        },
48        "negotiatedGrantDetail": {
49          "grantType": "Grant",
50          "id": "1X6xx00000000OECAY",
51          "quantity": 100,
52          "usageGrantNegotiable": "Negotiable",
53          "usageRefreshPolicy": {
54            "id": "1BYxx0000004C92GAE",
55            "negotiable": "Non-Negotiable"
56          },
57          "usageRolloverPolicy": {
58            "id": "1BVxx0000004C93GAE",
59            "negotiable": "Non-Negotiable"
60          },
61          "validityPeriodTerm": 1,
62          "validityPeriodUnit": "Month"
63        },
64        "negotiatedResourcePolicyDetail": {
65          "id": "1X5xx00000000OECAY",
66          "ratingFrequencyPolicy": {
67            "id": null,
68            "negotiable": null
69          },
70          "usageAggregationPolicy": {
71            "id": null,
72            "negotiable": null
73          },
74          "usageCommitmentPolicy": {
75            "id": "7Pexx0000004C92CAE",
76            "negotiable": "Non-Negotiable"
77          },
78          "usageOveragePolicy": {
79            "id": null,
80            "negotiable": null
81          }
82        },
83        "resourcePolicyDetail": {
84          "id": "7Suxx0000004C9kCAE",
85          "ratingFrequencyPolicy": {
86            "id": null,
87            "negotiable": null
88          },
89          "usageAggregationPolicy": {
90            "id": null,
91            "negotiable": null
92          },
93          "usageCommitmentPolicy": {
94            "id": "7Pexx0000004C92CAE",
95            "negotiable": "Non-Negotiable"
96          },
97          "usageOveragePolicy": {
98            "id": null,
99            "negotiable": null
100          }
101        }
102      },
103      "usageResourceId": "1BRxx0000004C9CGAU"
104    }
105  ]
106}

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	Usage Detail Error Response[]	List of errors encountered during the processing of the API request.	Small, 63.0	63.0
`records`	Rate Card Entry[]	List of rate card entry records.	Small, 63.0	63.0