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

# Get the AI credit summary

> The credits your contract gives for the period, the credits used, what remains, and the credits one call costs per tier. Covers the current contract period, as the app's AI Usage page does (all usage when Statisfy has not set up your contract yet). Read only: Statisfy sets the contract. Usage is refreshed as calls are made.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/credits/summary
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/credits/summary:
    get:
      tags:
        - credits
      summary: Get the AI credit summary
      description: >-
        The credits your contract gives for the period, the credits used, what
        remains, and the credits one call costs per tier. Covers the current
        contract period, as the app's AI Usage page does (all usage when
        Statisfy has not set up your contract yet). Read only: Statisfy sets the
        contract. Usage is refreshed as calls are made.
      operationId: credits_summary
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditSummary'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    CreditSummary:
      properties:
        contracted:
          description: >-
            Whether Statisfy has set up your credit contract. When false, usage
            is counted from the start at the default rates, and the period,
            allotment and remaining credits are null
          title: Contracted
          type: boolean
        is_overused:
          description: Whether total_used is more than total_allotted
          title: Is Overused
          type: boolean
        overused_by:
          anyOf:
            - type: number
            - type: 'null'
          description: The credits used over the allotment; null when not overused
          title: Overused By
        period_end:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The end of the current contract period (exclusive)
          title: Period End
        period_start:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The start of the current contract period
          title: Period Start
        rates:
          $ref: '#/components/schemas/Rates'
          description: The credits one call costs, per tier
        remaining:
          anyOf:
            - type: number
            - type: 'null'
          description: total_allotted minus total_used; below 0 when overused
          title: Remaining
        total_allotted:
          anyOf:
            - type: number
            - type: 'null'
          description: The credits the contract gives for the period
          title: Total Allotted
        total_used:
          description: The credits used in the period
          title: Total Used
          type: number
      required:
        - contracted
        - period_start
        - period_end
        - total_allotted
        - total_used
        - remaining
        - is_overused
        - overused_by
        - rates
      title: CreditSummary
      type: object
    Rates:
      properties:
        agents:
          description: Credits for one Tier 2 call (agents)
          title: Agents
          type: number
        llm:
          description: Credits for one Tier 1 call (LLM workflows)
          title: Llm
          type: number
        ppt_generation:
          description: Credits for one Tier 3 call (document and presentation generation)
          title: Ppt Generation
          type: number
      required:
        - llm
        - agents
        - ppt_generation
      title: Rates
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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