CustomerApiKey

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.

createdAt
Type: stringFormat: date-time
required

When the key was created.
customerExternalId
Type: string | null
required

Your ID for the customer.
customerId
Type: string
required

The customer the key belongs to (cus_…).
description
Type: string | null
required

What the key is for.
expiresAt
Type: string | nullFormat: date-time
required

When the key stops working, or null if it never expires.
id
Type: stringFormat: uuid
required

ID of the key.
keyPrefix
Type: string
required

The key's first 16 characters, to recognise it by.
last4
Type: string
required

The key's last 4 characters.
lastUsedAt
Type: string | nullFormat: date-time
required

When the key last authenticated a request, or null if never.
name
Type: string
required

The key's name.
revokedAt
Type: string | nullFormat: date-time
required

When the key was revoked, or null.
scopes
Type: array of "write:usage"enum
const:
write:usage
required

What the key may do: write:usage, sending signals.
status
Type: "ACTIVE" or "EXPIRED" or "REVOKED"enum
required

ACTIVE; EXPIRED once expiresAt has passed; REVOKED once revoked. Only ACTIVE keys work.