lomi.
Usage Billing

List usage billing periods

List usage billing periods

Overview

List usage billing periods

Returns billing periods for usage subscriptions, optionally filtered by subscription ID.

When to use this

Use for invoicing windows, period-close reconciliation, or support lookups.

See also

Get subscription usage · Usage billing guide

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 /usage-billing/periods

Base URLs:

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

Request

Path parameters

No path parameters beyond the URL pattern.

Query parameters

NameInRequiredSchemaDescription
page_sizequeryNo-
pagequeryNo-
subscription_idqueryNo-

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/usage-billing/periods?page_size=1&page=1" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

OpenAPI

  • operationId: UsageBillingController_listPeriods
  • Operation: GET /usage-billing/periods

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

On this page