Skip to content

Commit 3aad163

Browse files
committed
Make v3/cmx/stats endpoint description bulleted
Signed-off-by: Kyle Squizzato <[email protected]>
1 parent 9ce4f07 commit 3aad163

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/vendor/compatibility-matrix-usage.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,19 @@ is divided into distinct endpoints.
8484
To obtain summarized usage information in addition to your Compatibility Matrix
8585
credit balance, the `/v3/cmx/stats` endpoint can be used.
8686

87-
This endpoint returns the total number of terminated clusters and VMs, the total
88-
number of billed usage minutes, the total cost and the remaining credit balance.
87+
This endpoint returns:
8988

90-
The cost and remaining credit balance are returned in cents.
89+
- **`cluster_count`:** The total number of terminated clusters.
90+
- **`vm_count`:** The total number of terminated VMs.
91+
- **`usage_minutes`:** The total number of billed usage minutes.
92+
- **`cost`:** The total cost of the terminated clusters and VMs in cents.
93+
- **`credit_balance`:** The remaining credit balance in cents.
9194

9295
```shell
9396
curl --request GET \
9497
--url https://api.replicated.com/vendor/v3/customers \
9598
--header 'Accept: application/json' \
96-
--header 'Authorization: my-token'
99+
--header 'Authorization: $REPLICATED_API_TOKEN'
97100
{"cluster_count":2,"vm_count":4,"usage_minutes":152,"cost":276,"credit_balance":723}%
98101
```
99102

0 commit comments

Comments
 (0)