---
title: "Account, keys and billing"
description: "API keys and scopes, account limits, projects, webhooks, panel users, balance and invoices."
url: https://www.gyrohosting.com/developers/en/products/account.html
language: en
openapi: https://www.gyrohosting.com/developers/openapi.json
api_version: 2.30.0
---

# Account, keys and billing

API keys and scopes, account limits, projects, webhooks, panel users, balance and invoices.


## How-to guides

- [Authentication and scopes](https://www.gyrohosting.com/developers/en/guides/auth.md)
- [Responses and errors](https://www.gyrohosting.com/developers/en/guides/errors.md)
- [Pagination and rate limits](https://www.gyrohosting.com/developers/en/guides/limits.md)
- [Webhooks](https://www.gyrohosting.com/developers/en/guides/webhooks.md)

## Account

Key introspection and the write log of your API keys.

- `GET /whoami` — [Describe the calling API key](https://www.gyrohosting.com/developers/en/api/account.md#whoami)
- `GET /cloud/activity` — [List write calls made with your API keys](https://www.gyrohosting.com/developers/en/api/account.md#listActivity)
- `GET /ping` — [Ping](https://www.gyrohosting.com/developers/en/api/account.md#corePing)
- `GET /me` — [Get me](https://www.gyrohosting.com/developers/en/api/account.md#coreGetMe)
- `PATCH /me` — [Update me](https://www.gyrohosting.com/developers/en/api/account.md#coreUpdateMe)
- `GET /me/security` — [Get security](https://www.gyrohosting.com/developers/en/api/account.md#coreGetSecurity)
- `GET /me/notifications` — [Get notifications](https://www.gyrohosting.com/developers/en/api/account.md#coreGetNotifications)
- `PUT /me/notifications` — [Update notifications](https://www.gyrohosting.com/developers/en/api/account.md#coreUpdateNotifications)
- `GET /addresses` — [List addresses](https://www.gyrohosting.com/developers/en/api/account.md#coreGetAddresses)
- `POST /addresses` — [Create address](https://www.gyrohosting.com/developers/en/api/account.md#coreCreateAddress)
- `GET /addresses/{id}` — [Get address (path: {id})](https://www.gyrohosting.com/developers/en/api/account.md#coreGetAddress)
- `PUT /addresses/{id}` — [Update address (path: {id})](https://www.gyrohosting.com/developers/en/api/account.md#coreUpdateAddress)
- `DELETE /addresses/{id}` — [Delete address (path: {id})](https://www.gyrohosting.com/developers/en/api/account.md#coreDeleteAddress)
- `POST /addresses/{id}/default` — [Set default address (path: {id})](https://www.gyrohosting.com/developers/en/api/account.md#coreSetDefaultAddress)

## Account limits

Every limit of your account and its current usage in one place. Limits are raised on request: open a support ticket.

- `GET /cloud/account/limits` — [Account limits and usage](https://www.gyrohosting.com/developers/en/api/account-limits.md#getAccountLimits)

## API keys

Sub-account keys narrowed to services, actions or a reseller end-customer. Only GyroAPI `/cloud` routes accept them.

- `GET /cloud/keys` — [List sub-account keys (never shows tokens)](https://www.gyrohosting.com/developers/en/api/api-keys.md#listApiKeys)
- `POST /cloud/keys` — [Create a sub-account key (token returned once)](https://www.gyrohosting.com/developers/en/api/api-keys.md#createApiKey)
- `DELETE /cloud/keys/{id}` — [Delete a sub-account key](https://www.gyrohosting.com/developers/en/api/api-keys.md#deleteApiKey)

## Projects

Group your services into projects (e.g. one per business, client or environment). Every service is in exactly one project; services without one are in the default project (id 0). Invoices are not split by project.

- `GET /cloud/projects` — [List projects](https://www.gyrohosting.com/developers/en/api/projects.md#listProjects)
- `POST /cloud/projects` — [Create a project](https://www.gyrohosting.com/developers/en/api/projects.md#createProject)
- `GET /cloud/projects/{id}` — [Get a project with its service ids](https://www.gyrohosting.com/developers/en/api/projects.md#getProject)
- `PATCH /cloud/projects/{id}` — [Rename / recolour a project](https://www.gyrohosting.com/developers/en/api/projects.md#updateProject)
- `DELETE /cloud/projects/{id}` — [Delete a project](https://www.gyrohosting.com/developers/en/api/projects.md#deleteProject)
- `POST /cloud/projects/{id}/services` — [Move services into a project](https://www.gyrohosting.com/developers/en/api/projects.md#moveServicesToProject)
- `PUT /cloud/services/{id}/project` — [Set the project of a service](https://www.gyrohosting.com/developers/en/api/projects.md#setServiceProject)

## Webhooks

Signed HTTPS callbacks for service, invoice, order and ticket events.

- `GET /cloud/webhooks` — [List webhooks](https://www.gyrohosting.com/developers/en/api/webhooks.md#listWebhooks)
- `POST /cloud/webhooks` — [Create a webhook (secret returned once)](https://www.gyrohosting.com/developers/en/api/webhooks.md#createWebhook)
- `GET /cloud/webhooks/{id}` — [Get a webhook](https://www.gyrohosting.com/developers/en/api/webhooks.md#getWebhook)
- `PATCH /cloud/webhooks/{id}` — [Update url, events, description or status](https://www.gyrohosting.com/developers/en/api/webhooks.md#updateWebhook)
- `DELETE /cloud/webhooks/{id}` — [Delete a webhook](https://www.gyrohosting.com/developers/en/api/webhooks.md#deleteWebhook)
- `POST /cloud/webhooks/{id}/test` — [Send an api.test event now](https://www.gyrohosting.com/developers/en/api/webhooks.md#testWebhook)
- `GET /cloud/webhooks/{id}/deliveries` — [Last 100 deliveries](https://www.gyrohosting.com/developers/en/api/webhooks.md#listWebhookDeliveries)

## Panel users

Sub-users: extra panel logins with limited permissions (accountant, technical staff). Scope `users`.

- `GET /cloud/users` — [List sub-users](https://www.gyrohosting.com/developers/en/api/panel-users.md#listPanelUsers)
- `POST /cloud/users` — [Invite a sub-user](https://www.gyrohosting.com/developers/en/api/panel-users.md#createPanelUser)
- `PATCH /cloud/users/{id}` — [Update a sub-user (label, status, permissions)](https://www.gyrohosting.com/developers/en/api/panel-users.md#updatePanelUser)
- `DELETE /cloud/users/{id}` — [Remove a sub-user](https://www.gyrohosting.com/developers/en/api/panel-users.md#deletePanelUser)
- `POST /cloud/users/{id}/resend-invite` — [Resend the invitation e-mail](https://www.gyrohosting.com/developers/en/api/panel-users.md#resendPanelUserInvite)

## Billing

Invoices and account balance (read-only with the recommended scopes).

- `GET /invoices` — [List invoices](https://www.gyrohosting.com/developers/en/api/billing.md#listInvoices)
- `GET /invoices/{id}` — [Get an invoice](https://www.gyrohosting.com/developers/en/api/billing.md#getInvoice)
- `GET /balance` — [Account balance](https://www.gyrohosting.com/developers/en/api/billing.md#getBalance)
- `GET /balance/transactions` — [Balance ledger](https://www.gyrohosting.com/developers/en/api/billing.md#listBalanceTransactions)
- `POST /cloud/invoices/{id}/pay` — [Pay an invoice from the account balance](https://www.gyrohosting.com/developers/en/api/billing.md#payInvoiceFromBalance)
- `GET /cloud/invoices/{id}/pdf` — [Invoice PDF (base64 in JSON)](https://www.gyrohosting.com/developers/en/api/billing.md#getInvoicePdf)
- `POST /cloud/balance/top-up` — [Create a balance top-up invoice and get its payment link](https://www.gyrohosting.com/developers/en/api/billing.md#balanceTopUp)
- `POST /invoices/{id}/pay` — [Pay invoice (path: {id})](https://www.gyrohosting.com/developers/en/api/billing.md#corePayInvoice)
- `POST /invoices/{id}/coupon` — [Apply invoice coupon (path: {id})](https://www.gyrohosting.com/developers/en/api/billing.md#coreApplyInvoiceCoupon)
- `PATCH /balance/settings` — [Update balance settings](https://www.gyrohosting.com/developers/en/api/billing.md#coreUpdateBalanceSettings)
- `GET /cloud/billing/balance` — [Balance, hourly cost of running prepaid services and estimated time left](https://www.gyrohosting.com/developers/en/api/billing.md#getPrepaidBalance)
- `GET /cloud/billing/usage` — [Hour-by-hour usage ledger (or daily/monthly totals). Times are Europe/Istanbul.](https://www.gyrohosting.com/developers/en/api/billing.md#listPrepaidUsage)
- `GET /cloud/billing/statement/{month}` — [Monthly usage statement (not an invoice); JSON, PDF or CSV](https://www.gyrohosting.com/developers/en/api/billing.md#getPrepaidStatement)
- `POST /cloud/billing/estimate` — [Hourly / daily / monthly cost of prepaid plans and serverless containers, and how long the balance lasts](https://www.gyrohosting.com/developers/en/api/billing.md#estimatePrepaidCost)
- `GET /cloud/billing/topup-url` — [Browser link of the balance top-up page (top-ups are invoiced with VAT; usage is not)](https://www.gyrohosting.com/developers/en/api/billing.md#getPrepaidTopupUrl)
- `GET /cloud/billing/container-sizes` — [Serverless container sizes (vCPU / memory pairs) and prices](https://www.gyrohosting.com/developers/en/api/billing.md#getContainerSizes)

## Reference data

Countries, states, cities.

- `GET /reference/countries` — [List countries](https://www.gyrohosting.com/developers/en/api/reference-data.md#coreGetCountries)
- `GET /reference/countries/{code}/states` — [List states (path: {code})](https://www.gyrohosting.com/developers/en/api/reference-data.md#coreGetStates)
- `GET /reference/states/{id}/cities` — [List cities (path: {id})](https://www.gyrohosting.com/developers/en/api/reference-data.md#coreGetCities)