Rate Card Entry

Output representation of the details of a rate card entry.

JSON Example 

1{
2  "records": [
3    {
4      "bindingInstanceTargetType": "Product",
5      "bindingInstanceType": "Target",
6      "chargeForOverages": "Yes",
7      "fields": {},
8      "isOptional": false,
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}

If the negotiable property value is blank, then the data is derived from Product Catalog Management. If it isn’t blank, then the data is derived from Rate Management.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
binding​Instance​TargetTypeStringType of the target object that’s associated with this transaction.Big, 63.063.0
bindingInstance​TypeStringType of the binding instance. Valid values are Self or Target.Big, 63.063.0
chargeFor​OveragesStringSpecifies whether overage is permitted. Valid values are Yes, No, or NA.Big, 63.063.0
fieldsMap<String, Fields Response>List of optional fields and their values that’s associated with the rate card entry object.Big, 63.063.0
isOptionalBooleanIndicates whether the product usage resource is optional when the associated product is one of the commitment usage model types (true) or not (false).Big, 65.065.0
nameStringName of the resource.Big, 63.063.0
negotiableStringType of the base rate and the tier rate, if applicable. Valid values are Negotiable or Non-Negotiable.Big, 63.063.0
negotiated​RateDoubleUser-overridden overage rate.Big, 63.063.0
negotiated​RateCard​EntryIdStringID of the negotiated rate card entry and the tier rate card entry, if applicable.Big, 63.063.0
quantityDoubleAmount granted for the resource.Big, 63.063.0
rateDoubleBase overage rate.Big, 63.063.0
rate​AdjustmentsRate Adjustments[]List of tiers associated with the rate card entry, if applicable.Big, 63.063.0
rateCard​EntryIdStringID of the base rate card entry and the tier rate card entry, if applicable.Big, 63.063.0
rateUnit​OfMeasure​NameStringUnit of measure for rates in the rate card entry.Big, 64.064.0
unitOf​MeasureStringUnit of measure of the grant. For example, Unit.Big, 63.063.0
usageResource​IdStringID of the usage resource.Big, 65.065.0
usageResource​GrantAndPolicy​DetailUsage Resource Grant And Policy DetailDetails of a usage resource grant and policy.Big, 65.065.0