Account API
Read your wallet, invoices and monthly statements, notifications and project activity, and talk to support, with a Helipod API key.
The Account API gives your code the account pages of the dashboard: the wallet balance and its transactions, invoices and monthly statements, in-app notifications, the activity of a project, and support tickets. It reads; it never spends money.
https://api.helipod.io/api/accountAuthenticate with a Helipod API key that has Account API enabled. It is not in a new key's default products: tick it when you create the key.
curl https://api.helipod.io/api/account/wallet \
-H "Authorization: Bearer hel_your_key"Whole account or one project
Money and support belong to your account, not to a project. What a key reaches depends on how it was created:
| Route | Whole-account key | Key limited to one project |
|---|---|---|
| Wallet, transactions, invoices, statements | Yes | 403 ACCOUNT_KEY_REQUIRED |
| Support tickets | Yes | 403 ACCOUNT_KEY_REQUIRED |
| Notifications | All of yours | Only that project's |
| Project activity | Every project you own | Only that project |
Endpoints
| Method and path | |
|---|---|
| Wallet | GET /wallet, GET /wallet/transactions |
| Invoices | GET /invoices, GET /invoices/{invoiceId} |
| Statements | GET /statements, GET /statements/{month} |
| Notifications | GET /notifications, GET /notifications/unread-count, POST /notifications/read-all, POST /notifications/{notificationId}/read |
| Activity | GET /projects/{projectId}/activity |
| Tickets | GET POST /tickets, GET /tickets/{ticketId}, POST /tickets/{ticketId}/messages, POST /tickets/{ticketId}/close |
Wallet and invoices
Balance, transactions, invoices and the monthly statement.
Notifications and activity
What the dashboard's bell shows, and who did what in a project.
Tickets
Open a support ticket, reply and close it.
What stays in the dashboard
- Adding money. Top-ups by card, bank transfer or e-wallet happen on the dashboard's payment pages. The API shows a pending invoice's own
paymentUrlso you can send someone to pay it. - API keys and team members. Creating keys and inviting people is done in the dashboard.
Moving money from the wallet to the AI balance is part of the AI API.
Errors
Errors use the shared envelope.
| Status | Code | When |
|---|---|---|
401 | NO_API_KEY, INVALID_API_KEY, API_KEY_EXPIRED | Authentication failed |
403 | SCOPE_NOT_ALLOWED | The key was not given the Account API |
403 | ACCOUNT_KEY_REQUIRED | An account route with a key limited to one project |
400 | INVALID_MONTH | The month is not YYYY-MM |
400 | MONTH_NOT_STARTED | A statement for a month that has not started |
404 | INVOICE_NOT_FOUND, NOTIFICATION_NOT_FOUND, TICKET_NOT_FOUND, PROJECT_NOT_FOUND | Doesn't exist, or the key can't reach it |
409 | INVOICE_NOT_PAID | Invoice details exist only for paid invoices |
409 | TICKET_CLOSED | Replying to a closed ticket |
422 | VALIDATION_ERROR | The body or query does not match the schema |
429 | TOO_MANY_TICKETS, RATE_LIMITED | More than 5 new tickets an hour, or too many requests |