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

# Get Version

> Return the running build version and whether the configured payment gateways use test or live keys.

Returns the build identifier of the running API and the gateway mode it was
booted with. No authentication is required, and it touches no dependencies,
so it is also the cheapest request for a smoke test or a load-test baseline.
Use it to confirm which build a deploy landed and to check whether an
instance is in test or live mode before you create real charges (see
[Testing](/testing)). For dependency health, use
[Get Health](/api-reference/operations/health).

## Example Request

```bash theme={null}
curl https://api.recurso.dev/version
```

## Response

Returned bare — no `data` envelope.

```json theme={null}
{
  "version": "v0.14.0",
  "gateway_mode": "live"
}
```

## Fields

| Field          | Type   | Description                                                                                                                                                                                          |
| -------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `version`      | string | The build version stamped at compile time (for example `v0.14.0`). Unstamped builds report the Cloud Run revision name when one is available, otherwise `dev`.                                       |
| `gateway_mode` | string | `test` when any configured gateway key is a test key (`sk_test…` / `rzp_test…`), `live` when all configured keys are live, `none` when no real gateway is configured and the mock gateway is in use. |

<Note>
  `gateway_mode` is what the dashboard's "Test mode" chip reads. It also
  decides which API keys the instance accepts: live keys require a `live`
  server, test keys require a non-live one — a mismatch is rejected with
  `key_mode_mismatch` on every authenticated route.
</Note>

## Errors

This endpoint has no failure modes of its own and always returns `200`.


## OpenAPI

````yaml GET /version
openapi: 3.1.0
info:
  title: Recurso API
  version: 1.0.0
  description: |
    The Recurso billing engine REST API.

    Authenticate by passing your API key as a bearer token:

        Authorization: Bearer <api_key>

    Obtain an API key by registering a tenant via `POST /auth/register`.
    All authenticated endpoints live under the `/v1` prefix. Mutating
    endpoints support idempotency via the `Idempotency-Key` header.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://billing.example.com
    description: >-
      Example deployment — substitute the base URL of your own Recurso
      deployment.
security:
  - bearerAuth: []
tags:
  - name: System
    description: Health, version, and API metadata
  - name: Auth
    description: Tenant registration
  - name: Plans
    description: Product catalog plans
  - name: Customers
    description: Customer management
  - name: Subscriptions
    description: Subscription lifecycle
  - name: Invoices
    description: Invoices, PDFs, and Indian GST e-invoicing
  - name: Coupons
    description: Discounts
  - name: Usage
    description: Metered usage events
  - name: Credit Notes
    description: Customer credits
  - name: Quotes
    description: Quote-to-invoice lifecycle
  - name: Webhooks
    description: Webhook endpoint management and event feed
  - name: Analytics
    description: Revenue analytics
  - name: Checkout
    description: Public hosted checkout for invoices
  - name: Payments
    description: Payment order creation
  - name: Inbound Webhooks
    description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
  - name: Customer Portal
    description: Customer-facing portal — magic-link auth and session-scoped data
  - name: Developer
    description: API key management
  - name: Account
    description: Tenant account settings
  - name: Finance
    description: Ledger accounts, entries, reconciliation, and revenue recognition
  - name: Settings
    description: Tax (GST) and e-invoicing (IRP) configuration
  - name: Consents
    description: Consent records for RBI-compliant recurring billing
  - name: Referrals
    description: Customer referral program
  - name: Gifts
    description: Gift subscriptions
  - name: Mandates
    description: UPI Autopay mandates
  - name: Offline Payments
    description: Virtual accounts and manually recorded payments
  - name: Organizations
    description: Multi-entity organizations grouping several tenants
  - name: Accounting
    description: QuickBooks / Xero accounting integrations
  - name: Churn
    description: Churn risk scoring and alerts
  - name: Cancel Flows
    description: Configurable retention flows shown at cancellation time
  - name: Dunning
    description: Dunning analytics and multi-channel dunning campaigns
paths:
  /version:
    get:
      tags:
        - System
      summary: Build version
      operationId: getVersion
      responses:
        '200':
          description: The running build version.
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                  gateway_mode:
                    type: string
                    enum:
                      - test
                      - live
                      - none
                    description: >-
                      Whether the configured payment gateways use test or live
                      keys.
                    examples:
                      - dev
                      - v0.1.0
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Tenant API key obtained from `POST /auth/register` or `POST
        /v1/developer/keys`.

````