SignalInput
One usage event.
- eventType: string
Name min length:1requiredWhat happened, e.g.
document_uploaded. Plans price usage and spend credits by it. - attributionType:Properties: 2
Which of your products the usage is for.
- customerType:Properties: 2
Whose usage it is, by
customerIdorexternalCustomerId(one of them is required and can't be empty: 400 otherwise). Required unlesscustomerUnitis given. A customer that doesn't exist yet is accepted: the signal is kept unattributed and joins them once they do. With a customer API key, it must be the key's own customer. - customerType: object
Unit Properties: 1The customer unit (team, workspace or project) the usage belongs to. Without
customer, the unit's customer is the signal's customer, and a unit that doesn't exist is a 404CUSTOMER_UNIT_NOT_FOUND. Withcustomer, it must be that customer's unit (400CUSTOMER_UNIT_MISMATCH, also when that customer doesn't exist yet). Usage on a non-billable unit, or under one, is kept but not charged. - dataType: object | nullProperties: 1
Anything to keep with the signal; plans can price by its numbers (
quantity, or the field the plan names).trace_idlinks the AI costs traced under that trace ID;external_user_idnames the customer's user who did it. Keys_derived,_dimsand_billing, and keys starting with them and a dot, are reserved. - idempotencyType: string
Key Your unique ID for this event. A signal whose key was used before is a duplicate and isn't stored again. Keys don't expire. With an org key, keys can't start with
sb:ck:. - timestampType: stringFormat: date-time
When the usage happened (ISO 8601). Default when the request arrives.