API REFERENCE · SCHEMA

Usage schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas
environmentRequired
string

Values: "sandbox", "production".

periodRequired
string
usedRequired
integer

Minimum: 0.

reservedRequired
integer

Minimum: 0.

limitRequired
integer

Minimum: 0.

planLimitRequired
integer

Minimum: 0.

spendingCapRequired
integer

Minimum: 0.

effectiveLimitRequired
integer

Minimum: 0.

remainingRequired
integer

Minimum: 0.

planRequired
string
eventsRequired
object[]
events item fields

Each array item: object.

events[].kindRequired
string
events[].subjectsRequired
integer

Minimum: 0.

fileStorageRequired
objectView FileStorage schema
fileStorage fields and rules
fileStorage.planRequired
string
fileStorage.maxBytesRequired
integer

Minimum: 0.

fileStorage.usedBytesRequired
integer

Minimum: 0.

fileStorage.reservedBytesRequired
integer

Minimum: 0.

fileStorage.remainingBytesRequired
integer

Minimum: 0.

fileStorage.sandboxRequired
object
fileStorage.sandbox fields and rules
fileStorage.sandbox.maxBytesRequired
integer

Minimum: 0.

fileStorage.sandbox.usedBytesRequired
integer

Minimum: 0.

fileStorage.sandbox.reservedBytesRequired
integer

Minimum: 0.

fileStorage.sandbox.remainingBytesRequired
integer

Minimum: 0.

fileStorage.maxBatchUploadBytesRequired
integer

Minimum: 0.

fileStorage.maxEvidenceAttachmentBytesRequired
integer

Minimum: 0.

monitoringForecastRequired
MonitoringForecast or null

May be null.

monitoringForecast fields and rules

Allowed alternatives

  • MonitoringForecast
    monitoringForecast.generatedAtRequired
    string

    Format: date-time.

    monitoringForecast.periodEndRequired
    string

    Format: date-time.

    monitoringForecast.dailyScreeningsRequired
    number

    Minimum: 0.

    monitoringForecast.projectedRemainingScreeningsRequired
    integer

    Minimum: 0.

    monitoringForecast.effectiveLimitRequired
    integer

    Minimum: 0.

    monitoringForecast.usedRequired
    integer

    Minimum: 0.

    monitoringForecast.reservedRequired
    integer

    Minimum: 0.

    monitoringForecast.remainingRequired
    integer

    Minimum: 0.

    monitoringForecast.projectedExhaustionAtRequired
    string or null

    May be null.

    monitoringForecast.projectedExhaustionAt fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

  • null

    May be null.

forecastUnavailableRequired
string or null

May be null.

forecastUnavailable fields and rules

Allowed alternatives

  • string
  • null

    May be null.