> ## Documentation Index
> Fetch the complete documentation index at: https://docs.generalvalidation.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Organization's entitlement

> Returns the Organization's plan, status, and Table Pair allowance. Creating Table Pairs and preparing Runs need status `trialing` or `active`, or return 402.

Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader).



## OpenAPI

````yaml /api/openapi.json get /api/v1/billing/entitlement
openapi: 3.1.0
info:
  description: >-
    General Validation's API for Organization administration, Table Pair and
    Test authoring, Runs, and Result metadata. Microsoft Entra bearer tokens
    authorize every call.
  title: General Validation API
  version: 1.0.0
servers:
  - url: https://api.generalvalidation.com
security: []
tags:
  - description: >-
      Customer-owned Fabric references, immutable Runs, and safe Result
      summaries.
    name: Fabric
  - description: Organizations and verified membership.
    name: Organization
  - description: Subscriptions and entitlements.
    name: Billing
paths:
  /api/v1/billing/entitlement:
    get:
      tags:
        - Billing
      summary: Get the Organization's entitlement
      description: >-
        Returns the Organization's plan, status, and Table Pair allowance.
        Creating Table Pairs and preparing Runs need status `trialing` or
        `active`, or return 402.


        Requires the GV.APIReader application role, or a higher role (Owner >
        Contributor > Reader).
      operationId: get_organization_entitlement
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1OrganizationEntitlement'
          description: Successful Response
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A valid Microsoft Entra bearer token is required.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The authenticated principal does not have the required role.
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The bounded application request rate was exceeded.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A required dependency is temporarily unavailable.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
      security:
        - entraApplication: []
components:
  schemas:
    V1OrganizationEntitlement:
      additionalProperties: false
      properties:
        effectiveAt:
          description: When this entitlement started.
          title: Effectiveat
          type: string
        expiresAt:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When this entitlement ends, or null when it has no end date. After
            this time a `trialing` or `active` entitlement reads as `expired`.
          title: Expiresat
        pairCount:
          description: >-
            Table Pairs the Organization has now. Deleted Table Pairs do not
            count.
          minimum: 0
          title: Paircount
          type: integer
        pairLimit:
          description: >-
            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.
          minimum: 1
          title: Pairlimit
          type: integer
        planKey:
          description: The plan behind this entitlement.
          title: Plankey
          type: string
        revision:
          description: >-
            Increases each time the entitlement is updated. A trial or term that
            ends at expiresAt changes status without a new revision.
          minimum: 1
          title: Revision
          type: integer
        status:
          description: >-
            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.
          enum:
            - trialing
            - active
            - read_only
            - expired
            - cancelled
          title: Status
          type: string
      required:
        - pairLimit
        - pairCount
        - revision
        - planKey
        - status
        - effectiveAt
        - expiresAt
      title: V1OrganizationEntitlement
      type: object
    V1Problem:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable machine-readable error code, such as `precondition.failed`.
            Branch on this value.
          title: Code
          type: string
        detail:
          description: What went wrong in this request, written for a person.
          title: Detail
          type: string
        diagnostics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Extra details for some errors, such as `fieldErrors` for an invalid
            request or `requiredRole` for a denied one. Absent when there are
            none.
          title: Diagnostics
        instance:
          description: Path of the request that failed.
          title: Instance
          type: string
        requestId:
          description: >-
            This request's ID, also sent in the `X-Request-Id` response header.
            Quote it when you contact support. A request that sends an
            `X-Request-Id` of 1 to 64 letters, digits, or `_.:-` gets that value
            back.
          title: Requestid
          type: string
        status:
          description: The HTTP status code of this response.
          title: Status
          type: integer
        title:
          description: Short summary of the error code.
          title: Title
          type: string
        type:
          description: Link to the documentation page for this error code.
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
      title: V1Problem
      type: object
  securitySchemes:
    entraApplication:
      bearerFormat: JWT
      description: >-
        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.
      scheme: bearer
      type: http
      x-gv-app-roles:
        - GV.APIReader
        - GV.APIContributor
        - GV.APIOwner
      x-gv-audience: 78d5d8af-9dd6-49dd-b06c-38c3a3c707af
      x-gv-scope: api://78d5d8af-9dd6-49dd-b06c-38c3a3c707af/.default
      x-gv-token-url-template: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.