Skip to main content
GET
Customer Entities
Auth: secret key only. When API permissions are enabled, reads require entity:read and mutations require entity:write. Publishable keys cannot read the Entity directory. List Entities with an optional status, limit from 1 to 100, and opaque cursor:
Read one Entity:
Create or replace its display fields and status:
The upsert payload is a complete snapshot. When changing only status, send the current name and metadata so they are not cleared. Entity lifecycle operations never create billing events. If your product bills per seat, your backend must track that seat separately through the Events API. Bulk upsert accepts 1 to 500 unique external IDs:
Delete through the lifecycle endpoint:
Deletion is not a financial cascade. It preserves all source, allocation, operation, and audit rows. Retry an uncertain mutation with the same idempotency key and identical payload.