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

# Billing status

> Get billing and AI credit status.



## OpenAPI

````yaml /api-reference/openapi.json get /billing/status
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: approvals
    description: Approvals operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: local
    description: Local operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: routines
    description: Routines operations.
  - name: workspace
    description: Workspace operations.
paths:
  /billing/status:
    get:
      tags:
        - billing
      summary: Billing status
      description: Get billing and AI credit status.
      operationId: billing_status
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      slug:
                        type: string
                    required:
                      - id
                      - name
                      - slug
                    additionalProperties: false
                  availableCreditsCents:
                    type: number
                  creditConsumedCents:
                    type: number
                  billedCents:
                    type: number
                  onDemandSpendCents:
                    type: number
                  monthlySpendLimitCents:
                    type: number
                  spendLimitRemainingCents:
                    type: number
                  subscriptionStatus:
                    anyOf:
                      - type: string
                      - type: 'null'
                  stripeCustomerId:
                    anyOf:
                      - type: string
                      - type: 'null'
                  grants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        source:
                          type: string
                          enum:
                            - starter
                            - trial
                            - monthly
                            - topup
                            - manual
                            - referral
                        category:
                          type: string
                          enum:
                            - promotional
                            - paid
                        status:
                          type: string
                          enum:
                            - pending
                            - granted
                            - depleted
                            - expired
                            - voided
                        amountCents:
                          type: number
                        usedCents:
                          type: number
                        remainingCents:
                          type: number
                        effectiveAt:
                          type: number
                        expiresAt:
                          anyOf:
                            - type: number
                            - type: 'null'
                      required:
                        - id
                        - source
                        - category
                        - status
                        - amountCents
                        - usedCents
                        - remainingCents
                        - effectiveAt
                        - expiresAt
                      additionalProperties: false
                  nextCommands:
                    type: array
                    items:
                      type: string
                required:
                  - workspace
                  - availableCreditsCents
                  - creditConsumedCents
                  - billedCents
                  - onDemandSpendCents
                  - monthlySpendLimitCents
                  - spendLimitRemainingCents
                  - subscriptionStatus
                  - stripeCustomerId
                  - grants
                  - nextCommands
                additionalProperties: {}
              example:
                workspace:
                  id: org_abc123
                  name: Acme
                  slug: acme
                availableCreditsCents: 500
                creditConsumedCents: 120
                billedCents: 120
                onDemandSpendCents: 0
                monthlySpendLimitCents: 5000
                spendLimitRemainingCents: 4880
                subscriptionStatus: active
                stripeCustomerId: cus_abc123
                grants:
                  - id: gr_pqr678
                    source: starter
                    category: promotional
                    status: granted
                    amountCents: 500
                    usedCents: 120
                    remainingCents: 380
                    effectiveAt: 1765526400000
                    expiresAt: null
                nextCommands:
                  - dench billing topup --amount 20
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````