Skip to content
Nokku LogoNokku
API Referencev1.0.0 · 174 endpoints

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

nokku.v1.BillingService
POST
https://app.nokku.sh/nokku.v1.BillingService/GetBilling
Try it
Authorization (BearerAuth)

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Example 1
Connect-Timeout-Ms?number

Define the timeout, in ms

Example 1000

Authorization

  • BearerAuth (bearer)

    A service account token. Include it in the Authorization header: `Authorization: Bearer <token>`

  • CookieAuth (cookie: __Host-nokku_session)

    The session cookie the web app uses. Browsers send it after sign-in. Only on `localhost` it is named `nokku_session`.

Request Body

Required

application/json

nokku.v1.GetBillingRequest

Responses

200

Success

application/json

nokku.v1.GetBillingResponse
plan?
string
hosted?
boolean
features?
object

Map value

[key: string]?
boolean
quotas?
object
seats?
string <int64>
auditRetentionDays?
string <int64>
recordingStorageBytes?
string <int64>
resourceCap?
string <int64>
recordingRetentionDays?
string <int64>
userCount?
string <int64>
resourceCount?
string <int64>
heldQuotas?
object
seats?
string <int64>
auditRetentionDays?
string <int64>
recordingStorageBytes?
string <int64>
resourceCap?
string <int64>
recordingRetentionDays?
string <int64>
heldUntil?
string <date-time>

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 <date-time>

The end of a hosted trial, set until the first key is activated.

deleteAt?
string <date-time>

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 <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

default

Error

application/json

connect.error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

code?
string

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Enum:"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.

Code Samples

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

Example Responses

{
  "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"
  }
}