Zorveus LogoZorveusDOCS

Product Users

Programmatically manage, search, and track customer identities and usage limits.

Product Users are your customers. You can create or update them inline during inference or manage them explicitly using your Organization Service Key (zrv_service_...).

Service Key InserterInteractive
Paste your Zorveus key to dynamically update all code snippets below.

1. Look Up Product User Profile by External ID

Read a product user's live profile, configured spending cap, available credits, and monthly token usage without accidental creations or mutations.

curl -X GET "https://api.zorveus.com/product-users/by-external-id?app_id=app_support_123&external_user_id=usr_alex_8842" \
  -H "Authorization: Bearer zrv_service_your_service_key"

2. Check Live Credit Balance Only

For lightweight balance checks before initiating expensive operations, use the credit summary lookup:

curl -X GET "https://api.zorveus.com/product-users/by-external-id/credit-summary?app_id=app_support_123&external_user_id=usr_alex_8842&currency=USD" \
  -H "Authorization: Bearer zrv_service_your_service_key"

3. Upsert Product User by External ID

curl -X PUT https://api.zorveus.com/product-users/by-external-id \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer zrv_service_your_service_key" \
  -d '{
    "org_id": "org_startup_1048",
    "external_user_id": "usr_cust_94821",
    "name": "Sarah Connor",
    "email": "sarah.connor@example.com",
    "metadata": {
      "plan": "enterprise_seat",
      "company": "Cyberdyne Systems"
    }
  }'
Was this page helpful?
Edit this page on GitHub

On this page