Skip to content
Press.js Press.js Press.js Docs

Get usage overview

GET
/v1/usage
 
curl --request GET \
  --url https://api.presscloud.example/v1/usage \
  --header 'Authorization: Bearer <token>'

Returns the authenticated account’s current billing period, policy, quota, live storage, and usage meter totals.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Usage overview.

Media type application/json
object
bill
required
object
externalPriceRef
string
externalSubscriptionRef
string
interval
required
string
Allowed value: month
periodEnd
required
integer
periodStart
required
integer
provider
required
string
Allowed values: internal stripe
generatedAt
required
integer
liveStorage
required
object
deployVersionStorageBytes
required
integer
managedPdfStorageBytes
required
integer
renderOutputStorageBytes
required
integer
totalBytes
required
integer
period
required
object
end
required
integer
kind
required
string
Allowed value: current_bill_period
start
required
integer
usageDayEndExclusive
required
string format: date
usageDayStart
required
string format: date
plan
required
object
currency
required
string
>= 1 characters
interval
required
string
Allowed value: month
key
required
string
>= 1 characters
monthlyPriceCents
required
integer
name
required
string
>= 1 characters
policy
required
object
allowExternalNetwork
required
boolean
maxBytesPerDeployCommit
required
integer
maxConcurrentRenderJobs
required
integer
maxDeployCommitsPerBillPeriod
required
integer | null
maxFilesPerDeployCommit
required
integer
maxRenderJobsPerBillPeriod
required
integer | null
maxRenderOutputBytes
required
integer
maxRenderTimeMsPerBillPeriod
required
integer | null
maxRenderTimeoutMs
required
integer
storageLimitBytes
required
integer
storageMeters
required
Array<object>
object
aggregation
required
string
Allowed value: daily_peak
code
required
string
>= 1 characters
currentBytes
required
integer
description
string
peakBytesByDay
required
Array<object>
object
day
required
string format: date
peakBytes
required
integer
peakGiBDay
required
number
totalPeakBytes
required
integer
totalPeakGiBDays
required
number
unit
required
string
>= 1 characters
version
required
string
>= 1 characters
uploadLimits
required
object
maxSingleFileBytes
required
integer
usageMeters
required
Array<object>
object
aggregation
required
string
Allowed values: count daily_peak sum
code
required
string
>= 1 characters
description
string
totalQuantity
required
number
unit
required
string
>= 1 characters
version
required
string
>= 1 characters
Example 
{
  "bill": {
    "interval": "month",
    "provider": "internal"
  },
  "period": {
    "kind": "current_bill_period"
  },
  "plan": {
    "interval": "month"
  },
  "storageMeters": [
    {
      "aggregation": "daily_peak"
    }
  ],
  "usageMeters": [
    {
      "aggregation": "count"
    }
  ]
}

Headers

Section titled “Headers ”
Cache-Control
string
Allowed value: private, no-store

401

Section titled “401 ”

Authentication material for the operation is missing.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

403

Section titled “403 ”

The caller is not permitted to perform the operation.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}