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

# Get account credit balances

> Returns account-wide balances for email, lead, personalization, email_validation and social_action, including remaining, max, used and the current tier. Max is the plan allowance plus tier credits for the billing period. Annual plans include 12 months of credits, while lead capacity stays the same. Lead credits show capacity for additional active contacts across all workspaces, excluding agent contacts. Remaining can be negative when over capacity. For other credits, used is max minus remaining, with a minimum of zero; bonus credits can increase remaining above max. Agent and browser-extension/Leadsforge quotas are excluded.



## OpenAPI

````yaml https://api.salesforge.ai/public/v2/swagger/doc.json get /credits
openapi: 3.1.0
info:
  description: Get mailboxes associated with the workspace.
  termsOfService: https://www.salesforge.ai/terms
  title: Salesforge API
  version: '2.0'
servers:
  - url: https://api.salesforge.ai/public/v2
security:
  - ApiKeyAuth: []
externalDocs:
  description: ''
  url: ''
paths:
  /credits:
    get:
      tags:
        - account
      summary: Get account credit balances
      description: >-
        Returns account-wide balances for email, lead, personalization,
        email_validation and social_action, including remaining, max, used and
        the current tier. Max is the plan allowance plus tier credits for the
        billing period. Annual plans include 12 months of credits, while lead
        capacity stays the same. Lead credits show capacity for additional
        active contacts across all workspaces, excluding agent contacts.
        Remaining can be negative when over capacity. For other credits, used is
        max minus remaining, with a minimum of zero; bonus credits can increase
        remaining above max. Agent and browser-extension/Leadsforge quotas are
        excluded.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.AccountCreditsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.Error'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.Error'
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    api.AccountCreditsResponse:
      properties:
        credits:
          items:
            $ref: '#/components/schemas/api.AccountCreditBalance'
          type: array
          uniqueItems: false
      type: object
    errors.Error:
      allOf:
        - $ref: '#/components/schemas/data'
      properties:
        data: {}
        message:
          type: string
      type: object
    api.AccountCreditBalance:
      properties:
        max:
          type: integer
        remaining:
          type: integer
        tierId:
          type: string
        type:
          enum:
            - email
            - lead
            - personalization
            - email_validation
            - social_action
          type: string
        used:
          type: integer
      type: object
    data:
      properties:
        data:
          items:
            $ref: '#/components/schemas/api.DNCResponse'
          type: array
      type: object
    api.DNCResponse:
      properties:
        createdAt:
          type: string
        type:
          $ref: '#/components/schemas/models.DncType'
        value:
          type: string
      type: object
    models.DncType:
      enum:
        - email
        - domain
        - linkedin
      type: string
      x-enum-varnames:
        - DncTypeEmail
        - DncTypeDomain
        - DncTypeLinkedin
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey

````