For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
LoginSandbox
Platform GuidesAPI DocsSDKMCP ServerChangelog
Platform GuidesAPI DocsSDKMCP ServerChangelog
  • Getting started
    • Introduction
    • Concepts
    • Onboarding guide
  • Use cases
    • Monetizing an AI agent
    • Pricing models for AI products
    • Configuring entitlements for AI products
  • Usage metering & events
    • Meters
    • Usage events
    • Unmatched events
    • Event reprocessing
  • Products & plans
    • Product Catalog
    • Pricing Plans
    • Features & Entitlements
  • Wallets & credits
    • Credit types & wallets
    • Credits in pricing plans
  • Customers & subscriptions
    • Customers
    • Subscriptions
    • Quotes
  • Invoicing
    • Invoices
    • Invoice corrections
    • Payment Collections
    • Tax
    • Currencies & Exchange rates
    • E-invoicing
  • Analytics & reporting
    • Insights
    • Report downloads
    • Revenue Recognition & Deferred Revenue
  • Integrations
    • CRM
    • ERP
    • Email Providers
    • Data Imports: Event File Uploads
    • Data Exports
    • Payment Service Providers
  • Settings & admin
    • Billing entities
    • Payment Options
    • User management
    • Customising invoices
    • Custom fields
    • Default platform settings
    • API key creation
    • Alert Rules
    • Workflows
  • Workflows
    • Workflow Triggers
    • Workflow Actions
    • Monitoring and Audit
    • Common Use Cases
  • For developers
    • Introduction
    • Authentication
    • Local development setup
    • API
    • Errors
    • Troubleshooting
    • Query Parameters
    • Expanding Responses
    • Idempotency
    • Timestamp formatting
    • Webhooks
    • Locale
    • MCP Server
LoginSandbox
On this page
  • The four APIs
  • Environments
  • Request conventions
  • Recommended reading order
For developers

Introduction for developers

Was this page helpful?
Previous

Authentication

Next
Built with

This section covers everything you need to integrate with Solvimon: authentication, error handling, idempotency, webhooks, and HTTP conventions.

The four APIs

Solvimon exposes four separate APIs. Most integrations use all four.

APIBase pathWhat it’s for
Configuration API/v1/Create and manage meters, products, pricing plans, features
Identity API/v1/Create and manage customers, subscriptions
Transaction API/v1/Invoices, payments, credit notes
Event API/v1/Ingest usage events

Full endpoint reference is in the API Docs tab.

Environments

EnvironmentAPI base URLDesk URL
Testhttps://test.api.solvimon.com/v1/https://test.desk.solvimon.com
Productionhttps://api.solvimon.com/v1/https://desk.solvimon.com

Test and production are fully isolated. Test keys will not work against the production endpoint and vice versa. Data created in one environment never appears in the other.

Request conventions

Every request requires:

  • Content-Type: application/json
  • X-API-KEY: <your_key> — see Authentication
  • HTTPS — plain HTTP requests are rejected

Every response includes an X-REQUEST-ID header. Save this value when debugging; it’s required when contacting support about a specific request.

Recommended reading order

  1. Authentication — how to get and use your API key
  2. Errors — error codes and what they mean
  3. Idempotency — safely retrying requests
  4. Webhooks — receiving real-time event notifications