Skip to main content
GET
Get the Organization's entitlement

Authorizations

Authorization
string
header
required

Microsoft Entra application token issued by the caller's Organization tenant for this multitenant API. Request the .default scope and assign the application the required GV.APIReader, GV.APIContributor, or GV.APIOwner role.

Response

Successful Response

effectiveAt
string
required

When this entitlement started.

expiresAt
string | null
required

When this entitlement ends, or null when it has no end date. After this time a trialing or active entitlement reads as expired.

pairCount
integer
required

Table Pairs the Organization has now. Deleted Table Pairs do not count.

Required range: x >= 0
pairLimit
integer
required

Most Table Pairs the Organization can have at once. Creating one more returns 409 fabric.pair_limit_reached; deleting a Table Pair frees a slot.

Required range: x >= 1
planKey
string
required

The plan behind this entitlement.

revision
integer
required

Increases each time the entitlement is updated. A trial or term that ends at expiresAt changes status without a new revision.

Required range: x >= 1
status
enum<string>
required

Creating Table Pairs and preparing Runs need trialing or active, or return 402. read_only means a subscription exists but is past due, suspended, or outside its paid period; expired that the trial or term ended; cancelled that the subscription was cancelled.

Available options:
trialing,
active,
read_only,
expired,
cancelled