Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Subscription Plans

Update Plan Details

This endpoint updates the editable properties of an existing subscription plan, including its name, description, trial period, and billing limit.

patch/subscription/api/v1/subscription-plans/{planCode}

Path parameters

planCodestring required

The unique identifier of the subscription plan.

Request body

namestring

The updated name of the subscription plan.

descriptionstring

The updated description of the plan.

trialPeriodDaysinteger

The updated trial period in days.

billingLimitinteger

The updated maximum number of billing cycles.

Example request

{
  "name": "Pro Monthly Plus",
  "description": "Updated monthly subscription",
  "trialPeriodDays": 7,
  "billingLimit": 24
}

Response

Subscription plan details updated successfully

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the plan update operation.

Example response

{
  "success": true,
  "message": "Plan updated",
  "data": {
    "id": 34,
    "name": "The FIRST Day",
    "description": "Superior marketing",
    "amount": 800,
    "currency": "NGN",
    "interval": "MONTHLY",
    "intervalCount": 1,
    "trialPeriodDays": 5,
    "billingLimit": 2,
    "status": "ACTIVE",
    "planCode": "PLN_DD41251",
    "createdAt": "2026-07-08T16:42:53.051861",
    "updatedAt": "2026-07-08T17:25:31.342977889"
  }
}