> ## 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.

# Get authoritative checkout state



## OpenAPI

````yaml /api-reference/openapi.json get /credits/topups/{sessionId}
openapi: 3.1.0
info:
  title: Locus Pro API
  description: >-
    Access paid tools, manage prepaid balances, and build usage billing. Send
    money as exact decimal strings and reuse Idempotency-Key on retries.
    Management routes require a scoped server key or authorized dashboard
    session. Sensitive workspace changes require an owner or admin with recent
    MFA or passkey verification, except where an operation documents a stricter
    boundary. Interactive agents use MCP OAuth; unattended agents use scoped
    Agent Connections. Browser widgets use end-user tokens.
  version: 0.7.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: Feature-gated 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: MCP
    description: Stateless Streamable HTTP transport and MCP tool-result contracts
  - name: Okibi Identity
    description: >-
      Feature-gated 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: Hosted Workflows
    description: >-
      Tenant-private TypeScript Workflow definitions, immutable versions,
      bounded runs, artifacts, and recovery
  - name: Agent connections
    description: Scoped, expiring, revocable credentials for agent execution
  - name: Recipes
    description: >-
      Search, research, extraction, enrichment, and travel outcomes across
      providers
paths:
  /credits/topups/{sessionId}:
    get:
      tags:
        - Top-ups
      summary: Get authoritative checkout state
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
            pattern: ^cs_
      responses:
        '200':
          description: Checkout state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopupStatus'
        '400':
          $ref: '#/components/responses/TopupError'
      security:
        - dashboardSession: []
        - secretKey: []
components:
  schemas:
    TopupStatus:
      type: object
      required:
        - success
        - sessionId
        - state
        - paymentStatus
      properties:
        success:
          const: true
        sessionId:
          type: string
        state:
          type: string
          enum:
            - pending
            - completed
            - expired
        paymentStatus:
          type: string
    TopupError:
      type: object
      required:
        - success
        - error
        - code
        - message
      properties:
        success:
          const: false
        error:
          type: string
        code:
          type: string
          enum:
            - below_minimum
            - not_whole_cents
            - invalid_amount
            - invalid_amount_choice
            - invalid_request
            - invalid_url
            - invalid_external_user_id
            - invalid_metadata
            - identity_not_allowed
            - unknown_field
            - invalid_session_id
            - tenant_unavailable
            - missing_stripe_customer
        message:
          type: string
  responses:
    TopupError:
      description: Stable top-up validation, velocity, or ownership error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TopupError'
  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). High-risk workspace
        administration requires an owner or admin role and fresh MFA/passkey
        step-up.

````

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