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

# Credit balance and recent transactions

> The account credit balance and the 50 most recent ledger entries, newest first. Credit is always GBP minor units.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/client/credits
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/client/credits:
    get:
      tags:
        - Credits
      summary: Credit balance and recent transactions
      description: >-
        The account credit balance and the 50 most recent ledger entries, newest
        first. Credit is always GBP minor units.
      operationId: publicClientGetCredits
      responses:
        '200':
          description: Balance and ledger.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - balance
                      - currency
                      - transactions
                    properties:
                      balance:
                        type: integer
                        description: GBP minor units.
                      currency:
                        type: string
                        const: GBP
                      transactions:
                        type: array
                        maxItems: 50
                        items:
                          $ref: '#/components/schemas/PublicClientCreditTransaction'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicClientCreditTransaction:
      type: object
      required:
        - id
        - amount
        - balanceAfter
        - type
        - description
        - reference
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: integer
          description: GBP minor units; negative when credit was spent.
        balanceAfter:
          type: integer
          description: GBP minor units.
        type:
          type: string
          enum:
            - TOPUP
            - INVOICE_PAYMENT
            - ADMIN_ADJUSTMENT
            - REFUND
        description:
          type:
            - string
            - 'null'
        reference:
          type:
            - string
            - 'null'
          description: Usually the related invoice id.
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

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