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

# Read monthly plan and Enterprise trial status

> Requires a human workspace session with tenant:read. Trial expiry pauses Enterprise features without erasing prepaid balances or changing the assigned usage rate. Complete paid Enterprise checkout to restore those features; a top-up does not extend the trial.



## OpenAPI

````yaml /api-reference/openapi.json get /credits/plans
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/plans:
    get:
      tags:
        - Tenant
      summary: Read monthly plan and Enterprise trial status
      description: >-
        Requires a human workspace session with tenant:read. Trial expiry pauses
        Enterprise features without erasing prepaid balances or changing the
        assigned usage rate. Complete paid Enterprise checkout to restore those
        features; a top-up does not extend the trial.
      operationId: getCreditsPlanStatus
      parameters:
        - name: refresh
          in: query
          schema:
            type: boolean
            default: false
          description: Reconcile the current Stripe subscription before returning the plan.
      responses:
        '200':
          description: Current subscription, trial deadline and checkout availability
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                  enterpriseTrial:
                    oneOf:
                      - type: 'null'
                      - type: object
                        required:
                          - status
                          - startedAt
                          - endsAt
                        properties:
                          status:
                            enum:
                              - active
                              - expired
                          startedAt:
                            type: string
                            format: date-time
                          endsAt:
                            type: string
                            format: date-time
                        description: >-
                          A stored 14-day Enterprise trial. Paid conversion
                          clears the visible trial, preserves its audit dates
                          and keeps the assigned usage-pricing profile.
                  enabled:
                    type: boolean
                  currentPlan:
                    enum:
                      - free
                      - plus
                      - enterprise
                      - enterprise_plus
                  legacy:
                    type: boolean
                  checkoutConfigured:
                    type: boolean
                  includedBalanceUsd:
                    type: string
                  includedExpiresAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
        '403':
          description: Human workspace membership is required
      security:
        - dashboardSession: []
components:
  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.

````