lomi.

Retrieve subscription

Retrieve subscription

Overview

Retrieve subscription

Returns one subscription by ID including cycle and price references. Responds with 404 when unknown or inaccessible.

When to use this

Use before upgrades, cancelations, or invoicing integration.

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 /subscriptions/{id}

Base URLs:

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

Request

Path parameters

NameRequiredSchemaDescription
idYes-UUID de l’abonnement

Query parameters

No query parameters.

Responses

StatusDescription
200Success
401Invalid or missing API key
404Resource not found

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/subscriptions/value" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

OpenAPI

  • operationId: SubscriptionsController_findOne
  • Operation: GET /subscriptions/{id}

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

On this page