# GetBilling

`POST /nokku.v1.BillingService/GetBilling`

GetBilling also asks the license server for the current key, so new seats show up at once.

Base URL: https://app.nokku.sh

## Authorization

- BearerAuth: HTTP bearer
- CookieAuth: API key in cookie `__Host-nokku_session`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Connect-Protocol-Version` | header | number | no | Define the version of the Connect protocol |
| `Connect-Timeout-Ms` | header | number | no | Define the timeout, in ms |

## Request body (application/json, required)


Example:

```json
{}
```

## Responses

### 200: Success

Returns `nokku.v1.GetBillingResponse`.

- `plan` (string)
- `hosted` (boolean)
- `features` (object)
- `quotas` (object)
  - `seats` (string)
  - `auditRetentionDays` (string)
  - `recordingStorageBytes` (string)
  - `resourceCap` (string)
  - `recordingRetentionDays` (string)
- `userCount` (string)
- `resourceCount` (string)
- `heldQuotas` (object)
  - `seats` (string)
  - `auditRetentionDays` (string)
  - `recordingStorageBytes` (string)
  - `resourceCap` (string)
  - `recordingRetentionDays` (string)
- `heldUntil` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
- `trialEndsAt` (string): The end of a hosted trial, set until the first key is activated.
- `deleteAt` (string): When a hosted workspace whose plan ended is deleted.
- `license` (object): The key this response was resolved from, after the refresh.
  - `plan` (string)
  - `active` (boolean)
  - `expiresAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

```json
{
  "plan": "string",
  "hosted": true,
  "features": {
    "property1": true,
    "property2": true
  },
  "quotas": {
    "seats": "string",
    "auditRetentionDays": "string",
    "recordingStorageBytes": "string",
    "resourceCap": "string",
    "recordingRetentionDays": "string"
  },
  "userCount": "string",
  "resourceCount": "string",
  "heldQuotas": {
    "seats": "string",
    "auditRetentionDays": "string",
    "recordingStorageBytes": "string",
    "resourceCap": "string",
    "recordingRetentionDays": "string"
  },
  "heldUntil": "2023-01-15T01:30:15.01Z",
  "trialEndsAt": "2023-01-15T01:30:15.01Z",
  "deleteAt": "2023-01-15T01:30:15.01Z",
  "license": {
    "plan": "string",
    "active": true,
    "expiresAt": "2023-01-15T01:30:15.01Z"
  }
}
```

### default: Error

Returns `connect.error`.

- `code` (string): The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. One of: `canceled`, `unknown`, `invalid_argument`, `deadline_exceeded`, `not_found`, `already_exists`, `permission_denied`, `resource_exhausted`, `failed_precondition`, `aborted`, `out_of_range`, `unimplemented`, `internal`, `unavailable`, `data_loss`, `unauthenticated`.
- `message` (string): A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- `details` (array<connect.error_details.Any>): A list of messages that carry the error details. There is no limit on the number of messages.

```json
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}
```

## Example request

```bash
curl -X POST 'https://app.nokku.sh/nokku.v1.BillingService/GetBilling' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{}'
```
