Skip to content

Usage crossed a configured threshold

POST

Delivered as a CloudEvents 1.0 envelope whose data is a UsageSummary. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.

Media typeapplication/json
Array
object
specversion
required
string
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

string
/^evt_[0-9A-HJKMNP-TV-Z]{26}$/
source
required
type
required

Event type from events.json, e.g. sweep.execution.completed

string
time
required
string format: date-time
subject

Primary resource id

string
datacontenttype
string
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.usage.threshold
data
required
object
period_start
required
string format: date-time
period_end
required
string format: date-time
rate_card_version
required
string
plan
required
string
currency
required
string
Allowed values: usd
current_spend_cents
required
integer
projected_period_spend_cents
required
integer
ceiling_cents
One of:
integer
remaining_headroom_cents
One of:
integer
meters
required
Array<object>
object
meter
required
string
unit
required
string
used
required
number
included
required
number
overage
required
number
rated_cents
required
integer
next_threshold
One of:
object
at_quantity
number
description
string
simulated
required
boolean

Acknowledge with any 2xx within 10 seconds