Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Subscription Plans

Create Plan

This endpoint creates a new subscription plan.

Note:

  • Save the generated planCode after creating a plan. This value is required when creating subscriptions.
post/subscription/api/v1/subscription-plans

Request body

namestring required

The name of the subscription plan.

descriptionstring

A brief overview or summary explaining what the plan offer entails.

amountnumber required

The amount to charge on each billing cycle. Must be greater than or equal to zero.

currencystring required

The 3-letter ISO currency code for the billing.

intervalstring required

Billing frequency. Supported values are DAILY, WEEKLY, MONTHLY, QUARTERLY, and ANNUAL.

trialPeriodDaysinteger required

Number of free trial days before billing begins. Defaults to 0.

billingLimitinteger

The maximum number of billing cycles. Leave empty for unlimited billing.

Example request

{
  "name": "Basic Monthly Instant",
  "description": "Basic tier billed monthly",
  "amount": 100,
  "currency": "NGN",
  "interval": "MONTHLY",
  "trialPeriodDays": 2,
  "billingLimit": 1
}

Response

Funding Successful

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the plan creation operation.

Example response

{
  "success": true,
  "message": "Plan created",
  "data": {
    "id": 69,
    "name": "Basic Monthly (B)",
    "description": "Basic tier billed monthly",
    "amount": 100,
    "currency": "NGN",
    "interval": "MONTHLY",
    "intervalCount": 1,
    "trialPeriodDays": 2,
    "billingLimit": 1,
    "status": "ACTIVE",
    "planCode": "PLN_821DCFD",
    "createdAt": "2026-07-08T17:17:14.173360552",
    "updatedAt": "2026-07-08T17:17:14.173362175"
  }
}