An API for your account.

Authentication & permissions

Create a key from API & integrations. Choose full control, read-only or custom permissions. It grants no access to other accounts or server administration. Linking phones and creating connections still require the appropriate subscription and permissions.

GET /api/account/v1/account
Authorization: Bearer YOUR_ACCOUNT_API_KEY
Accept: application/json

The key is shown once; only its digest is stored. Revoke it at any time. Changing the account password or email invalidates existing account keys. Limits: 120 requests per minute per key and 20 active keys per account.

Subscribe, then link

Get plans and receiving wallets from GET /billing. Create an order for a new phone, then submit the transaction ID for manual review. After approval, pass the subscription device_id as subscription_id to link the phone. Submitting a transaction ID alone does not activate service.

POST /api/account/v1/billing/orders
{"device_id":"new","phone_name":"US phone","plan_id":"plus",
 "wallet_id":"YOUR_CONFIGURED_WALLET_ID","idempotency_key":"YOUR_UNIQUE_CHECKOUT_ID"}

POST /api/account/v1/create
{"subscription_id":"APPROVED_SUBSCRIPTION_DEVICE_ID","name":"US phone","relay_id":"AVAILABLE_RELAY_ID"}

The account key is independent of phone keys. A phone key covers one phone and is issued after its subscription is active. Phone keys grant no billing access.

Your account operations

Endpoints and request bodies follow the same rules as the user workspace. Use a unique idempotency key for checkout and a client_id for messages. Email and password changes require the current password; a new email still requires verification. Account keys are managed through the dashboard and cannot issue other account keys.

Responses & errors

401: invalid key. 402: paid subscription required. 403: permission or email verification required. 404: resource outside your account. 409: conflict or service limit. 429: rate limit. 503: relay unavailable. Check the result before retrying a financial request or deletion.