v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Subscription Plans

List Plans

This endpoint retrieves a paginated list of subscription plans that have been created by the merchant.

get/subscription/api/v1/subscription-plans?page={page}&size={size}&status={status}

Path parameters

pageinteger required

The page number to be retrieved.

sizeinteger required

The number of records per page.

statusstring

Filter plans by status (ACTIVE or ARCHIVED).

Response

Payment successful

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the operation.

Example response

{
  "success": true,
  "message": "Success",
  "data": {
    "content": [
      {
        "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.173361",
        "updatedAt": "2026-07-08T17:17:14.173362"
      }
    ],
    "pageable": {
      "sort": {
        "sorted": true
      },
      "pageSize": 1,
      "paged": true
    },
    "totalPages": 4,
    "totalElements": 4,
    "numberOfElements": 1,
    "size": 1,
    "sort": {
      "sorted": true
    },
    "first": true
  }
}