lomi.
Merchants

Get merchant MRR

Get merchant MRR

Overview

Get merchant MRR

Returns monthly recurring revenue for the merchant tied to the given ID.

When to use this

Use for subscription analytics when operating on a merchant-scoped identifier.

See also

Organization metrics

Authentication

Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.

Endpoint

GET /merchants/{id}/mrr

Base URLs:

  • https://sandbox.api.lomi.africa
  • https://api.lomi.africa

Request

Path parameters

NameRequiredSchemaDescription
idYes-Merchant UUID

Query parameters

No query parameters.

Responses

StatusDescription
200Success

Errors

Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.

Example

curl -sS -X GET "https://sandbox.api.lomi.africa/merchants/value/mrr" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

OpenAPI

  • operationId: MerchantsController_getMrr
  • Operation: GET /merchants/{id}/mrr

Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.

On this page