The commercial ceiling was reached
POST
Delivered as a CloudEvents 1.0 envelope whose data is a CommercialEnvelope. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.
Request Body
Section titled “Request Body”Media typeapplication/json
Array
object
specversion
required
string
id
required
Prefixed ULID (evt_…)
string
source
required
string
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
data
required
object
key
additional properties
sweepsimulated
CloudEvents extension: true in developer test mode.
boolean
type
required
data
required
The standing commercial envelope: authorize once, let ordinary usage continue within the ceiling.
object
version
required
integer
plan
required
string
rate_card_version
required
string
terms_version
required
string
included_allowances
required
object
key
additional properties
number
authorized_meters
required
Array<string>
monthly_ceiling_cents
required
integer
category_ceilings
object
key
additional properties
integer
current_period_rated_cents
required
integer
remaining_headroom_cents
required
integer
ceiling_policy
required
string
effective_from
required
string format: date-time
Responses
Section titled “Responses”Acknowledge with any 2xx within 10 seconds