CustomerApiKeyWithSecret
A customer API key just created, with its secret.
An API key your customer uses to send its own usage. It can call only
POST /signals/bulk, and only for signals naming this customer.- createdType: stringFormat: date-time
At requiredWhen the key was created.
- customerType: string | null
External Id requiredYour ID for the customer.
- customerType: string
Id requiredThe customer the key belongs to (
cus_…). - descriptionType: string | nullrequired
What the key is for.
- expiresType: string | nullFormat: date-time
At requiredWhen the key stops working, or
nullif it never expires. - idType: stringFormat: uuidrequired
ID of the key.
- keyType: stringrequired
The full key,
sb_ck_live_<company>_<secret>. Returned only in this response: store it now. - keyType: string
Prefix requiredThe key's first 16 characters, to recognise it by.
- last4Type: stringrequired
The key's last 4 characters.
- lastType: string | nullFormat: date-time
Used At requiredWhen the key last authenticated a request, or
nullif never. - nameType: stringrequired
The key's name.
- revokedType: string | nullFormat: date-time
At requiredWhen the key was revoked, or
null. - scopesType: array of "write:usage"enumconst:write:usagerequired
What the key may do:
write:usage, sending signals. - statusType: "ACTIVE" or "EXPIRED" or "REVOKED"enumrequired
ACTIVE;EXPIREDonceexpiresAthas passed;REVOKEDonce revoked. OnlyACTIVEkeys work.