Cancel subscription

Overview

Cancel subscription

Cancels an active subscription; optional reason is stored for analytics and chargeback context.

When to use this

Use when the customer ends service or you enforce policy cancellations.

See also

Retrieve 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

POST /subscriptions/{id}/cancel

Base URLs:

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

Request

Path parameters

Query parameters

No query parameters.

Request body

JSON request payload.

Schema: object

Example body:

{
  "cancel_at_period_end": true,
  "cancellation_reason": "string"
}

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/subscriptions/value/cancel" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cancel_at_period_end":true,"cancellation_reason":"string"}'

OpenAPI

• operationId: SubscriptionsController_cancel
• Operation: POST /subscriptions/{id}/cancel

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