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

# List the account's payment history

> Returns only TOPUP ledger entries for the account's pooled balance, newest first. Available to Personal and enterprise accounts. Manual top-ups and automatic reloads are distinguished by entry metadata; this narrow history does not expose provider charges, end-user rows, or margin data.



## OpenAPI

````yaml /api-reference/openapi.json get /credits/tenants/me/topups
openapi: 3.1.0
info:
  title: Locus Pro API
  description: >-
    Production is live at https://api.paywithlocus.com/api. Stage remains
    available for evaluation and integration testing at
    https://api.stage.paywithlocus.com/api; credentials, balances, and tenant
    data are isolated by environment. Embedded prepaid credits over the Locus
    pay-per-use catalog. Money and top-up amounts use exact decimal strings (up
    to 6dp). Every burn requires an Idempotency-Key header. Management routes
    accept a tenant secret key or authorized dashboard session as shown per
    operation. Widget routes accept an end-user JWT alone; when a publishable
    key is present it must belong to the JWT's tenant. MCP uses OAuth 2.1
    Authorization Code with PKCE by default and also accepts the explicitly
    documented tenant secret key, end-user JWT, or scoped agent connection
    compatibility credentials. Burns accept the execution credentials shown per
    operation. Publishable keys never authorize management or burns by
    themselves.
  version: 0.6.0
servers:
  - url: https://api.paywithlocus.com/api
    description: Production
  - url: https://api.stage.paywithlocus.com/api
    description: Stage — evaluation and integration testing
security:
  - secretKey: []
tags:
  - name: Authentication
    description: Email-verified self-serve account creation and dashboard identity
  - name: Tenants
    description: Tenant profile, keys, and settings (dashboard session or secret key)
  - name: Workspace members
    description: Invite-only human workspace membership and role administration
  - name: Catalog
    description: Enable/disable APIs and set markups
  - name: Custom APIs
    description: >-
      Available when enabled for the workspace. Enterprise BYOK providers and
      schema-backed custom actions
  - name: End users
    description: End-user accounts, tokens, and allocations
  - name: Top-ups
    description: Locus-hosted checkout top-ups and quotes
  - name: Ledger
    description: Burn/top-up history and earnings
  - name: Webhooks
    description: Signed events, delivery inspection, and replay
  - name: Burn
    description: Metered pay-per-use calls
  - name: Travel routing
    description: >-
      Available when enabled for the workspace. Multi-provider flight search,
      no-dispatch planning, and feedback
  - name: MCP
    description: Stateless Streamable HTTP transport and MCP tool-result contracts
  - name: Okibi Identity
    description: >-
      Available when enabled for the workspace. Okibi identity verification and
      scoped native CLI credential bootstrap
  - name: Widget
    description: End-user JWT surface; a matching publishable key is optional
  - name: Agent-native onboarding
    description: >-
      Self-registration, human Stripe funding handoff, and restricted account
      setup for headless agents
  - name: Agent connections
    description: Scoped, expiring, revocable credentials for agent execution
  - name: Capability routing
    description: Outcome-level web search and research across eligible catalog providers
paths:
  /credits/tenants/me/topups:
    get:
      tags:
        - Top-ups
      summary: List the account's payment history
      description: >-
        Returns only TOPUP ledger entries for the account's pooled balance,
        newest first. Available to Personal and enterprise accounts. Manual
        top-ups and automatic reloads are distinguished by entry metadata; this
        narrow history does not expose provider charges, end-user rows, or
        margin data.
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 25
            default: 25
          description: Maximum entries to return.
        - name: cursor
          in: query
          description: Opaque nextCursor from the previous page.
          schema:
            type: string
      responses:
        '200':
          description: Top-up history page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LedgerPage'
        '403':
          $ref: '#/components/responses/InsufficientScope'
      security:
        - dashboardSession: []
        - secretKey: []
components:
  schemas:
    LedgerPage:
      type: object
      additionalProperties: false
      required:
        - success
        - entries
        - nextCursor
      properties:
        success:
          type: boolean
          const: true
        entries:
          type: array
          items:
            $ref: '#/components/schemas/LedgerEntry'
        nextCursor:
          type:
            - string
            - 'null'
    LedgerEntry:
      type: object
      additionalProperties: false
      required:
        - id
        - direction
        - category
        - amountUsdc
        - amountCredits
        - balanceAfterUsdc
        - baseUsdc
        - marginUsdc
        - markupBps
        - sourceKey
        - externalReference
        - externalUserId
        - metadata
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        direction:
          type: string
          enum:
            - DEBIT
            - CREDIT
        category:
          type: string
        amountUsdc:
          $ref: '#/components/schemas/DecimalString'
        amountCredits:
          $ref: '#/components/schemas/DecimalString'
        balanceAfterUsdc:
          $ref: '#/components/schemas/DecimalString'
        baseUsdc:
          oneOf:
            - $ref: '#/components/schemas/DecimalString'
            - type: 'null'
        marginUsdc:
          oneOf:
            - $ref: '#/components/schemas/DecimalString'
            - type: 'null'
        markupBps:
          type:
            - integer
            - 'null'
        sourceKey:
          type: string
        externalReference:
          type:
            - string
            - 'null'
        externalUserId:
          type:
            - string
            - 'null'
        metadata: {}
        createdAt:
          type: string
          format: date-time
    InsufficientScopeError:
      type: object
      additionalProperties: false
      required:
        - success
        - error
        - code
        - message
        - requiredScopes
        - presentScopes
      properties:
        success:
          const: false
        error:
          const: Forbidden
        code:
          const: INSUFFICIENT_SCOPE
        message:
          type: string
        requiredScopes:
          type: array
          items:
            $ref: '#/components/schemas/CreditsTenantScope'
          minItems: 1
          uniqueItems: true
        presentScopes:
          type: array
          items:
            $ref: '#/components/schemas/CreditsTenantScope'
          uniqueItems: true
    DecimalString:
      type: string
      pattern: ^\d+(?:\.\d{1,6})?$
      description: >-
        Non-negative exact decimal string with at most six fractional digits.
        Endpoint-specific positivity and amount limits still apply.
    CreditsTenantScope:
      type: string
      enum:
        - tenant:read
        - tenant:write
        - catalog:write
        - credits:move
        - credentials:manage
        - tokens:manage
        - payouts:manage
        - members:manage
        - widget:read
  responses:
    InsufficientScope:
      description: >-
        The authenticated management credential lacks one or more required
        scopes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InsufficientScopeError'
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Tenant secret key (lcr_…). Server-side only.
    dashboardSession:
      type: http
      scheme: bearer
      description: Locus Pro dashboard session (Cognito).

````