Skip to main content
POST
Get pane license status

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for checking whether the organization is licensed to use a PANE app.

paneId
string | null

Id of the pane (the id in the pane's hostname, .pane.rhombus.com)

Response

200 - application/json

OK

Whether the organization may use a PANE app right now, and why not if it may not.

error
boolean | null
errorMsg
string | null
gracePeriodEndDate
string<date-time> | null
date-time

When the current entitlement lapses; absent for a license granted without a term

licenseUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

licensed
boolean | null

True when an active pane license is assigned to the pane

reason
enum<string>

LICENSED, or why the pane is not licensed: NO_LICENSE, EXPIRED, INVALID_STATE

Available options:
LICENSED,
NO_LICENSE,
EXPIRED,
INVALID_STATE
warningMsg
string | null
Last modified on September 11, 2026