Billing Events
When a billing consumption occurs in the integrator’s Space, Tencent eSign pushes a billing event notification to the integrator’s configured callback URL.
Event Types
billing_usage_deductedevent
Billing quota consumption — Triggered when envelope, eKYC, or other billable operations occur within the integrator's Space
Payload Structure
EventTypestring
Event type, fixed as billing_usage_deducted
OccurredAtstring
Event occurrence time, RFC3339 format, e.g. 2026-06-01T10:00:00Z
AppIdstring
AppId of the integration app that triggered the consumption (for sub-tenant consumption, this is the third-party app AppId)
SpaceIdstring
Space ID where the consumption originated (the Space of the envelope sender)
UserIdstring
User ID that initiated the consumption (corresponds to the integrator-side user identifier)
EnvelopeIdstring
Associated envelope ID; empty if the consumption is not envelope-related (e.g. eKYC)
UsageTypestring
Consumption type, enum: ses (SES envelope) / ekyc (eKYC verification) / member (member seat)
PackageNamestring
Name of the consumed package
Quantityinteger
Number of units consumed in this event
Remarkstring
Remark, currently empty
Payload Example
{
"EventType": "billing_usage_deducted",
"OccurredAt": "2026-06-01T10:00:00Z",
"AppId": "APxQk2mN8pR4vW1yH3jT5bZ6aE7cF0ab",
"SpaceId": "SGSPxQk2mN8pR4vW1yH3jT5bZ6aE7cF0",
"UserId": "SG_1234567890",
"EnvelopeId": "ENV_xxx",
"UsageType": "ses",
"PackageName": "SES Envelope Pack - 100",
"Quantity": 1,
"Remark": ""
}