Skip to content
Trusty Sweep Developers

A renewal was detected

POST

Delivered as a CloudEvents 1.0 envelope whose data is a Subscription. 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
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

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

Https://api.trustysweep.com

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
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.intel.renewal.detected
data
required
object
id
required

Prefixed ULID (sub_…)

string
/^sub_[0-9A-HJKMNP-TV-Z]{26}$/
vendor
required
string
vendorDomain
One of:
string
product
One of:
string
status
required
string
Allowed values: active trial cancelled paused unknown
cadence
required
string
Allowed values: weekly monthly quarterly annual usage one_time unknown
amountCents
One of:
integer
currency
required
string
annualizedCents
One of:
integer
nextRenewalAt
One of:
string format: date-time
lastChargeAt
One of:
string format: date-time
previousAmountCents
One of:
integer
priceChangePercent
One of:
number
cancellationPath
One of:
string
evidenceLevel
required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string
Allowed values: CONFIRMED DETECTED ESTIMATED
confidence
required
number
evidence
required
Array<object>
object
kind
required
string
Allowed values: email statement api invoice contract receipt user derived
ref
required
string
sourceId
string
observedAt
required
string format: date-time
excerpt
string
<= 300 characters
lastActivityAt
One of:
string format: date-time
activeDays90
One of:
integer
updatedAt
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds