GitBook Billing API

openapi: 3.2.0
info:
  title: GitBook Billing API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:
- name: Billing
  x-page-icon: credit-card
  x-page-title: Billing
  x-page-description: Organize payment details and subscription plans for your organization.
  description: Centralize billing activities here, including updating payment methods, adjusting subscriptions, or reviewing invoices. Simplify how you track and control costs.
paths:
  /orgs/{organizationId}/billing/ai-usage:
    get:
      operationId: getOrganizationAIUsage
      summary: Get AI credit usage by AI feature and time period
      description: 'Returns recorded AI usage for an organization. Calendar buckets use UTC;

        weeks start on Monday. Requires organization administrator permissions.'
      x-gitbook-mcp: true
      tags:
      - Billing
      security:
      - user: []
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - name: from
        in: query
        required: true
        description: Inclusive start timestamp. Cannot be older than two years from now.
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        required: true
        description: Exclusive end timestamp.
        schema:
          type: string
          format: date-time
      - name: interval
        in: query
        description: Calendar interval used to aggregate usage.
        schema:
          $ref: '#/components/schemas/AIUsageInterval'
      responses:
        '200':
          description: AI usage, including empty periods in the requested range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAIUsage'
components:
  schemas:
    EntityId:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      description: A unique entity identifier
    OrganizationAIUsage:
      type: object
      required:
      - periods
      - from
      - to
      properties:
        from:
          type: string
          format: date-time
          description: Inclusive start of the queried range.
        to:
          type: string
          format: date-time
          description: Exclusive end of the queried range, capped at the current instant.
        periods:
          type: array
          description: Chronological calendar buckets. Edge buckets include only the requested dates.
          items:
            type: object
            required:
            - date
            - credits
            - features
            properties:
              date:
                type: string
                format: date
                description: UTC date at the start of this calendar bucket.
              credits:
                type: number
                description: Total credits used in this bucket.
              features:
                type: array
                items:
                  type: object
                  required:
                  - feature
                  - credits
                  - creditsPercent
                  properties:
                    feature:
                      type: string
                      description: AI feature category with recorded credit usage.
                    credits:
                      type: number
                    creditsPercent:
                      type: number
                      description: Percentage of this bucket's total credits (0 to 100).
    AIUsageInterval:
      type: string
      description: UTC calendar interval for AI usage, with weeks starting on Monday.
      enum:
      - day
      - week
      - month
      - year
      default: day
  parameters:
    organizationId:
      name: organizationId
      in: path
      required: true
      description: The unique id of the organization
      schema:
        $ref: '#/components/schemas/EntityId'
  securitySchemes:
    user:
      type: http
      scheme: bearer
    user-internal:
      type: http
      scheme: bearer
    user-staff:
      type: http
      scheme: bearer
    integration:
      type: http
      scheme: bearer
    integration-installation:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.gitbook.com/authorize
          tokenUrl: https://oauth.gitbook.com/token
          scopes:
            user:read: Read your GitBook user profile.
            organization:read: Read the organizations you belong to, their settings and metadata, and their AI agent conversations.
            organization:write: Create organizations, and update organization settings and AI agent conversations.
            organization:members:read: Read organization members, teams, invites and link invites.
            organization:members:write: Manage organization members, teams, invites and link invites.
            organization:ask: Ask AI questions across an organization's content.
            organization:search: Search across an organization's content.
            space:read: Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.
            space:write: Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.
            space:permissions:read: Read the users and teams who have access to spaces and collections.
            space:permissions:write: Manage who has access to spaces and collections, including inviting users and teams.
            change-request:merge: Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.
            site:read: Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.
            site:write: Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.
            site:publish: Publish and unpublish sites, controlling their public exposure.
            site:permissions:read: Read the users and teams who have access to sites.
            site:permissions:write: Manage who has access to sites, including inviting users and teams.
            site:auth:read: Read how visitors authenticate on a site and its security configuration, including private share links.
            site:auth:write: Manage how visitors authenticate on a site and its security configuration, including private share links.
            site:insights:read: Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.
            site:ask: Ask AI questions across a site's content.
            site:search: Search across a site's content.
            integration:read: Read integrations, their status and where they are installed.
            integration:installations:read: Read integration installations and their configuration, which can include credentials for third-party services.
            integration:installations:write: Install and configure integrations on an organization, its spaces and its sites.
            integration:publish: Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.
            integration:delete: Unpublish integrations, permanently deleting them and every installation of them.
            openapi:read: Read OpenAPI specifications.
            openapi:write: Create, update and delete OpenAPI specifications.
x-provenance:
  method: harvested
  publisher: GitBook
  source: https://api.gitbook.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)