Get tenant details API Reference

GET

/tenants/{tenant}

Retrieve full details for a tenant including plan, members, resource usage, and status. The response includes an ETag header for use with optimistic locking on subsequent PATCH requests.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Responses

200

Tenant details

object

contactEmail

string

Example

admin@acme.com

createdAt

string

Example

2026-01-15T10:30:00Z

displayName

string

Example

Acme Corp

enforceLogLimit

boolean

enforceMetricsLimit

boolean

Example

true

members

Array<object>

object

email

string

Example

alice@acme.com

role

string

Example

admin

name

string

Example

acme

plan

string

Example

pro

resourceVersion

string

Example

184920

status

object

allocatedResources

object

cpu

string

Example

8

memory

string

Example

32

storage

string

Example

200

billing

object

nextBillingDate

NextBillingDate is when the next arrears bill fires (RFC 3339).

string

Example

2026-07-01T00:00:00Z

paddleSubscriptionStatus

PaddleSubscriptionStatus mirrors the Paddle payment-vehicle subscription status. The tenant is billing-ready only while this is active or trialing.

string

Allowed values: active trialing past_due paused canceled

Example

active

remainingCredits

RemainingCredits is the current remaining promotional credit balance.

string

Example

25.00

clusterCount

integer

Example

3

currentUsage

object

compute

object

cpuCoreHours

string

Example

2976.00

cpuCost

string

Example

89.28

memoryCost

string

Example

35.83

memoryGiBHours

string

Example

5971.97

storageCost

string

Example

8.63

storageGiBHours

string

Example

74400.00

currency

string

Example

GBP

error

string

estimatedCreditsApplied

string

Example

10.00

estimatedSubtotal

string

Example

166.15

estimatedTotal

string

Example

156.15

haCost

HACost is the estimated high-availability charge accrued so far this period (live HA plus any drained pending HA charges). Exposed as its own bucket so the displayed breakdown reconciles to EstimatedSubtotal.

string

Example

21.60

observability

object

billableActiveSeriesP95

integer

Example

41000

currentActiveSeries

integer

Example

42000

logIngestBytes

integer

Example

12500000000

logIngestGB

string

Example

12.50

logOverageCost

string

Example

0.00

metricsOverageCost

string

Example

0.00

periodEnd

string

Example

2026-04-30T12:00:00Z

periodStart

string

Example

2026-04-01T00:00:00Z

planChangedInPeriod

boolean

stale

boolean

updatedAt

string

Example

2026-04-07T12:00:00Z

phase

string

Example

Active

poolResources

object

cpu

string

Example

8

memory

string

Example

32

storage

string

Example

200

Headers

ETag

string

Resource version for optimistic locking

400

Invalid tenant name

object

code

string

error

string

field

string

message

string

severity

string

401

Missing or invalid authentication

object

code

string

error

string

field

string

message

string

severity

string

403

Not a member of this tenant

object

code

string

error

string

field

string

message

string

severity

string

404

Tenant not found

object

code

string

error

string

field

string

message

string

severity

string

429

Rate limit exceeded

object

code

string

error

string

field

string

message

string

severity

string