Docs
Get Storage Usage
GET /usage/storage
GET
/usage/storageThe storage card: stored bytes against the allowance, as of the last hourly reading. One billing read; never calls the Event or Org API. Requires OrganizationAdmin. Fields: policy (HardStop or Overage; HardStop when the org has no policy row), isTrial (trials always stop at the allowance), carriesMeter (false means the subscription cannot bill overage, so it stops at the allowance), allowanceBytes (live: core seats now times gbPerSeat times 2^30), storedBytes (as of readingAt; null before the first reading), overageGbMonths (period to date) and overagePrice ({ perGbMonth, currency } in whole units; null when no storage price is configured). For where the bytes sit, use Usage_GetStorageBreakdown.
Response
| Field | Type | Description |
|---|---|---|
| period | GetStorageUsageResponsePeriodInfo | |
| policy | string| null | |
| isTrial | boolean | |
| carriesMeter | boolean | |
| coreSeats | integer | |
| gbPerSeat | integer | |
| allowanceBytes | integer | |
| storedBytes | integer | |
| readingAt | date-time| null | |
| overageGbMonths | number | |
| overageReported | number| null | |
| lastReportedAt | date-time| null | |
| overagePrice | GetStorageUsageResponseOveragePriceInfo |
GetStorageUsageResponsePeriodInfo
| Field | Type | Description |
|---|---|---|
| start | date-time | |
| end | date-time |
GetStorageUsageResponseOveragePriceInfo
| Field | Type | Description |
|---|---|---|
| perGbMonth | number | |
| currency | string| null |