lomi.

Update subscription

Update subscription

Overview

Update subscription

Patches an organization subscription (metadata, price, or fields supported by the API).

When to use this

Use for plan changes initiated from your admin tools or customer portal backends.

See also

Retrieve subscription · Cancel subscription

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

PATCH /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.

Request body

No application/json body for this operation.

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

OpenAPI

  • operationId: SubscriptionsController_update
  • Operation: PATCH /subscriptions/{id}

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

On this page