Change subscription plan
Change subscription plan
Overview
Change subscription plan
Updates the price_id on an active subscription for upgrades or downgrades.
When to use this
Use when moving a customer to a different recurring price on the same product line.
See also
Retrieve subscription · Update 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}/change-plan
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
| Name | Required | Schema | Description |
|---|---|---|---|
id | Yes | - | UUID de l’abonnement |
Query parameters
No query parameters.
Request body
JSON request payload.
Schema: object
| Field | Required | Type | Description |
|---|---|---|---|
price_id | Yes | string | - |
Example body:
{
"price_id": "string"
}Responses
| Status | Description |
|---|---|
200 | Success |
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/change-plan" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"price_id":"string"}'OpenAPI
- operationId:
SubscriptionsController_changePlan - Operation:
POST /subscriptions/{id}/change-plan
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.