Create a usage subscription

Overview

Create a usage subscription

Enrolls a customer on a usage_based product without an upfront charge. Required before billing metered usage to that customer.

When to use this

After creating a usage-based product and meter; enroll each customer before sending usage events tied to a subscription.

See also

Usage billing guide · Products guide · Subscription usage

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

POST /usage-subscriptions

Base URLs:

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

Request

Path parameters

No path parameters beyond the URL pattern.

Query parameters

No query parameters.

Request body

No application/json body for this operation.

Responses

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 POST "https://sandbox.api.lomi.africa/usage-subscriptions" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

OpenAPI

• operationId: UsageEventsController_createUsageSubscription
• Operation: POST /usage-subscriptions

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