CloudPDF
DocsPricing
Start building

License status

GET/v1/deployment/license/statusv3.0.0-next.9

License decision plus usage-reporting and meter snapshots for this deployment.

Self-hosted surface. On managed CloudPDF this is operated by the platform — your account is already a tenant. Start at Tenant documents.

Authentication#

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.deployment.licenseStatus();

Responses#

200OK
application/jsonDeploymentLicenseStatusResponse
licenseunknownoptional
reportingunknownoptional
usageunknownoptional
defaultError
application/jsonAdminErrorPayload
errorobject
codestring
messagestring