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

# Retrieve organization subscriptions

> Retrieve connection statuses and available ChatGPT and Claude usage. Provider usage errors are reported without failing the response.



## OpenAPI

````yaml https://api.tembo.io/public-api/openapi/public get /v1/organizations/{organizationId}/subscriptions
openapi: 3.1.0
info:
  title: Tembo Public API
  description: >-
    Manage agents, sessions, repositories, and organization resources with the
    Tembo API.
  version: 1.0.0
servers:
  - url: https://api.tembo.io
    description: Tembo API
  - url: https://{deployment-origin}/api/public-api
    description: Self-hosted Tembo
    variables:
      deployment-origin:
        default: tembo.example.com
        description: Hostname of your self-hosted Tembo deployment
security: []
paths:
  /v1/organizations/{organizationId}/subscriptions:
    get:
      tags:
        - Organizations
      summary: Retrieve organization subscriptions
      description: >-
        Retrieve connection statuses and available ChatGPT and Claude usage.
        Provider usage errors are reported without failing the response.
      operationId: retrieveOrganizationSubscriptions
      parameters:
        - in: path
          name: organizationId
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Retrieve organization subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  chatgpt:
                    type: object
                    properties:
                      connected:
                        type: boolean
                      usage:
                        type:
                          - object
                          - 'null'
                        properties:
                          planType:
                            type: string
                            enum:
                              - free
                              - go
                              - plus
                              - pro
                              - prolite
                              - team
                              - self_serve_business_prolite
                              - self_serve_business_usage_based
                              - business
                              - ent26
                              - enterprise_cbp_automation
                              - enterprise_cbp_usage_based
                              - enterprise
                              - edu
                              - edu_plus
                              - edu_pro
                              - unknown
                          rateLimits:
                            type: array
                            items:
                              type: object
                              properties:
                                limitId:
                                  type:
                                    - string
                                    - 'null'
                                limitName:
                                  type:
                                    - string
                                    - 'null'
                                planType:
                                  type:
                                    - string
                                    - 'null'
                                  enum:
                                    - free
                                    - go
                                    - plus
                                    - pro
                                    - prolite
                                    - team
                                    - self_serve_business_prolite
                                    - self_serve_business_usage_based
                                    - business
                                    - ent26
                                    - enterprise_cbp_automation
                                    - enterprise_cbp_usage_based
                                    - enterprise
                                    - edu
                                    - edu_plus
                                    - edu_pro
                                    - unknown
                                    - null
                                primary:
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    usedPercent:
                                      type: number
                                    windowDurationMins:
                                      type:
                                        - integer
                                        - 'null'
                                      exclusiveMinimum: 0
                                    resetsAt:
                                      type:
                                        - integer
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - usedPercent
                                    - windowDurationMins
                                    - resetsAt
                                  additionalProperties: false
                                secondary:
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    usedPercent:
                                      type: number
                                    windowDurationMins:
                                      type:
                                        - integer
                                        - 'null'
                                      exclusiveMinimum: 0
                                    resetsAt:
                                      type:
                                        - integer
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - usedPercent
                                    - windowDurationMins
                                    - resetsAt
                                  additionalProperties: false
                                credits:
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    hasCredits:
                                      type: boolean
                                    unlimited:
                                      type: boolean
                                    balance:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - hasCredits
                                    - unlimited
                                    - balance
                                  additionalProperties: false
                                individualLimit:
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    limit:
                                      type: string
                                    used:
                                      type: string
                                    remainingPercent:
                                      type: number
                                    resetsAt:
                                      type: integer
                                      minimum: 0
                                  required:
                                    - limit
                                    - used
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                spendControlReached:
                                  type:
                                    - boolean
                                    - 'null'
                                rateLimitReachedType:
                                  type:
                                    - string
                                    - 'null'
                                  enum:
                                    - rate_limit_reached
                                    - workspace_owner_credits_depleted
                                    - workspace_member_credits_depleted
                                    - workspace_owner_usage_limit_reached
                                    - workspace_member_usage_limit_reached
                                    - unknown
                                    - null
                              required:
                                - limitId
                                - limitName
                                - planType
                                - primary
                                - secondary
                                - credits
                                - individualLimit
                                - spendControlReached
                                - rateLimitReachedType
                              additionalProperties: false
                          rateLimitResetCredits:
                            type:
                              - object
                              - 'null'
                            properties:
                              availableCount:
                                type: integer
                                minimum: 0
                              credits:
                                type:
                                  - array
                                  - 'null'
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    resetType:
                                      type: string
                                      enum:
                                        - codexRateLimits
                                        - unknown
                                    status:
                                      type: string
                                      enum:
                                        - available
                                        - redeeming
                                        - redeemed
                                        - unknown
                                    grantedAt:
                                      type: integer
                                      minimum: 0
                                    expiresAt:
                                      type:
                                        - integer
                                        - 'null'
                                      minimum: 0
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                    description:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - resetType
                                    - status
                                    - grantedAt
                                    - expiresAt
                                    - title
                                    - description
                                  additionalProperties: false
                            required:
                              - availableCount
                              - credits
                            additionalProperties: false
                          tokenUsage:
                            type: object
                            properties:
                              summary:
                                type: object
                                properties:
                                  lifetimeTokens:
                                    type:
                                      - integer
                                      - 'null'
                                    minimum: 0
                                  peakDailyTokens:
                                    type:
                                      - integer
                                      - 'null'
                                    minimum: 0
                                  longestRunningTurnSec:
                                    type:
                                      - integer
                                      - 'null'
                                    minimum: 0
                                  currentStreakDays:
                                    type:
                                      - integer
                                      - 'null'
                                    minimum: 0
                                  longestStreakDays:
                                    type:
                                      - integer
                                      - 'null'
                                    minimum: 0
                                required:
                                  - lifetimeTokens
                                  - peakDailyTokens
                                  - longestRunningTurnSec
                                  - currentStreakDays
                                  - longestStreakDays
                                additionalProperties: false
                              dailyUsageBuckets:
                                type:
                                  - array
                                  - 'null'
                                items:
                                  type: object
                                  properties:
                                    startDate:
                                      type: string
                                      format: date
                                    tokens:
                                      type: integer
                                      minimum: 0
                                  required:
                                    - startDate
                                    - tokens
                                  additionalProperties: false
                            required:
                              - summary
                              - dailyUsageBuckets
                            additionalProperties: false
                          fetchedAt:
                            type: string
                            format: date-time
                        required:
                          - planType
                          - rateLimits
                          - rateLimitResetCredits
                          - tokenUsage
                          - fetchedAt
                        additionalProperties: false
                      usageError:
                        type:
                          - object
                          - 'null'
                        properties:
                          code:
                            type: string
                            enum:
                              - reconnectRequired
                              - rateLimited
                              - unavailable
                          message:
                            type: string
                          retryAfter:
                            type:
                              - string
                              - 'null'
                        required:
                          - code
                          - message
                          - retryAfter
                        additionalProperties: false
                    required:
                      - connected
                      - usage
                      - usageError
                    additionalProperties: false
                  claude:
                    type: object
                    properties:
                      connected:
                        type: boolean
                      reconnectRequired:
                        type: boolean
                      usage:
                        type:
                          - object
                          - 'null'
                        properties:
                          rateLimits:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: five_hour
                                    label:
                                      type: string
                                      const: 5-hour limit
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: seven_day
                                    label:
                                      type: string
                                      const: Weekly limit
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: seven_day_oauth_apps
                                    label:
                                      type: string
                                      const: Weekly limit · OAuth apps
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: seven_day_opus
                                    label:
                                      type: string
                                      const: Weekly limit · Opus
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: seven_day_sonnet
                                    label:
                                      type: string
                                      const: Weekly limit · Sonnet
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    key:
                                      type: string
                                      const: seven_day_cowork
                                    label:
                                      type: string
                                      const: Weekly limit · Cowork
                                    detail:
                                      type: 'null'
                                    remainingPercent:
                                      type: integer
                                      minimum: 0
                                      maximum: 100
                                    resetsAt:
                                      type:
                                        - number
                                        - 'null'
                                      minimum: 0
                                  required:
                                    - key
                                    - label
                                    - detail
                                    - remainingPercent
                                    - resetsAt
                                  additionalProperties: false
                        required:
                          - rateLimits
                        additionalProperties: false
                      usageError:
                        type:
                          - object
                          - 'null'
                        properties:
                          code:
                            type: string
                            enum:
                              - reconnectRequired
                              - rateLimited
                              - unavailable
                          message:
                            type: string
                          retryAfter:
                            type:
                              - string
                              - 'null'
                        required:
                          - code
                          - message
                          - retryAfter
                        additionalProperties: false
                    required:
                      - connected
                      - reconnectRequired
                      - usage
                      - usageError
                    additionalProperties: false
                  supergrok:
                    type: object
                    properties:
                      connected:
                        type: boolean
                    required:
                      - connected
                    additionalProperties: false
                required:
                  - chatgpt
                  - claude
                  - supergrok
                additionalProperties: false
        '400':
          description: Invalid request or missing organization information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Organization administrator access is required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Organization resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Organization operation conflicts with existing state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Organization operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '502':
          description: The subscription provider is unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '503':
          description: Required organization storage is unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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