You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/embeds/rc-cost-report-api.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,4 @@ To get the cost report using the REST API:
5
5
The response includes a `taskId` that you can use to track the status of the report generation.
6
6
7
7
1. Use [`GET /tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to check report generation status. The report is ready when the `status` is `processing-completed` and the `response` field contains a `costReportId`.
8
-
1. Use [`GET /cost-report/{costReportId}`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getCostReport" >}}) to download the generated cost report.
9
-
10
-
The cost report returned from the Redis Cloud REST API contains all columns from the [FOCUS column library](https://focus.finops.org/focus-columns/).
8
+
1. Use [`GET /cost-report/{costReportId}`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getCostReport" >}}) to download the generated cost report.
Copy file name to clipboardExpand all lines: content/operate/rc/api/examples/generate-cost-report.md
+74Lines changed: 74 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,3 +110,77 @@ When the report is ready, the `status` is `processing-completed` and the `respon
110
110
To get the cost report, use [`GET /cost-report/{costReportId}`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getCostReport" >}}) with the `costReportId` from the previous step.
111
111
112
112
You can use this cost report with any FOCUS-compatible cost reporting tool to analyze and visualize your costs.
113
+
114
+
### Cost report fields
115
+
116
+
The cost report returned from the Redis Cloud REST API contains fields from the [FOCUS column library](https://focus.finops.org/focus-columns/). The Redis Cloud-specific implementation is described in the following sections.
|`BillingAccountName`| String | Display name of the Redis Cloud account. |
124
+
|`BillingAccountType`| String | Type of billing account structure. Always set to `Redis Cloud`. |
125
+
|`PublisherName`| String | Publisher/vendor of the service, which is Redis. Always `redis.io`. |
126
+
127
+
#### Pricing fields
128
+
129
+
| Field | Type | Description |
130
+
|---|---|---|
131
+
|`PricingCategory`| String | Pricing model category. Always `Standard`. |
132
+
|`PricingCurrency`| String | The currency used for pricing. Always `USD`. |
133
+
|`PricingQuantity`| BigDecimal | Quantity of units being priced. For hourly services like Redis Cloud Pro, this is the number of hours. For monthly services like Redis Cloud Essentials and network costs, this is typically one month. |
134
+
|`PricingUnit`| String | The unit of measure for pricing. Can be `Hours` (Pro), `Months` (Essentials), or `Network`. |
135
+
136
+
#### Period fields
137
+
138
+
| Field | Type | Description |
139
+
|---|---|---|
140
+
|`BillingPeriodStart`| Instant (ISO 8601 DateTime) | Start of the billing period (inclusive). |
141
+
|`BillingPeriodEnd`| Instant (ISO 8601 DateTime) | End of the billing period (exclusive). |
142
+
|`ChargePeriodStart`| Instant (ISO 8601 DateTime) | Start of the specific charge period (inclusive). May differ from billing period if the resource was created mid-period. |
143
+
|`ChargePeriodEnd`| Instant (ISO 8601 DateTime) | End of the specific charge period (exclusive). May differ from billing period if the resource was deleted mid-period. |
144
+
145
+
#### Cost fields
146
+
147
+
| Field | Type | Description |
148
+
|---|---|---|
149
+
|`BilledCost`| BigDecimal | Cost that Redis will invoice you for. |
150
+
|`BillingCurrency`| String (ISO 4217) | Currency code for all billing amounts. Always `USD`. |
151
+
|`ConsumedQuantity`| BigDecimal | Actual amount of resources used. May be null for fixed-price plans. |
152
+
|`ConsumedUnit`| String | Unit for `ConsumedQuantity`. Can be `Hours` or `Network`. |
153
+
|`ContractedCost`| BigDecimal | Cost after applying contractual discounts but before credits. |
154
+
|`ContractedUnitPrice`| BigDecimal | Per-unit price after applying your negotiated discounts. |
155
+
|`EffectiveCost`| BigDecimal | True cost after all discounts, credits, and adjustments. |
156
+
|`ListCost`| BigDecimal | Cost at Redis's published list prices before any discounts. |
157
+
|`ListUnitPrice`| BigDecimal | Redis's published price per unit at list rates. |
158
+
159
+
#### Location, Resource, and SKU fields
160
+
161
+
| Field | Type | Description |
162
+
|---|---|---|
163
+
|`RegionId`| String | Cloud vendor region identifier. |
164
+
|`RegionName`| String | Display name of the region. |
165
+
|`ResourceId`| String | Identifier of the resource being charged. |
166
+
|`ResourceName`| String | Display name you gave to the resource in the Redis Cloud console. |
167
+
|`ResourceType`| String | Whether the charge is for a specific database or a subscription-level service. |
168
+
|`Tags`| JSON Map<String, String> | User-defined tags on resources. |
169
+
|`SkuPriceDetails`| JSON Map<String, Object> | Redis-specific technical details about the database configuration, such as RBUs, memory limit, and throughput. |
170
+
171
+
#### Charge fields
172
+
173
+
| Field | Type | Description |
174
+
|---|---|---|
175
+
|`ChargeCategory`| String | Category of the charge: `Usage`, `Purchase`, `Tax`, or `Adjustment`. |
176
+
|`ChargeDescription`| String | A clear description of what you're being charged for, combining service type and resource details. |
177
+
|`ChargeFrequency`| String | How often the charge occurs - always `Recurring`. |
178
+
179
+
#### Service fields
180
+
181
+
| Field | Type | Description |
182
+
|---|---|---|
183
+
|`ServiceCategory`| String | The high-level category of service - always `Databases`. |
184
+
|`ServiceName`| String | The Redis Cloud service tier - `Redis Cloud Pro` or `Redis Cloud Essentials`. |
185
+
|`ServiceSubcategory`| String | The specific type of database service - always `Caching`. |
Copy file name to clipboardExpand all lines: content/operate/rc/billing-and-payments/cost-report.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,4 +101,4 @@ You can use the [Redis Cloud REST API]({{< relref "/operate/rc/api" >}}) to get
101
101
102
102
{{< embed-md "rc-cost-report-api.md" >}}
103
103
104
-
See [Generate FOCUS-compliant cost report with REST API]({{< relref "/operate/rc/api/examples/generate-cost-report" >}}) for examples.
104
+
The cost report returned from the Redis Cloud REST API contains fields from the [FOCUS column library](https://focus.finops.org/focus-columns/). See [Generate FOCUS-compliant cost report with REST API]({{< relref "/operate/rc/api/examples/generate-cost-report" >}}) for more details.
0 commit comments