List subscriptions

Endpoint

GET /clients/business/subscriptions

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 10.

string

Filter by package name.

string

Filter by billing interval.

string

Filter by subscription amount (in kobo).

string

Search across subscription fields by keyword.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of subscription objects.

string

Unique subscription ID.

string

Name of the subscription package.

string

Billing amount in kobo.

string

Billing interval.

string

The business this subscription belongs to.

string

The client account this subscription belongs to.

integer

The current page number.

integer

The page size used for this response.

integer

Total number of records matching the current query, across all pages.

integer

The final page number, derived from total ÷ limit. See Pagination — this endpoint uses Shape B.

Code examples

curl -X GET "https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions?page=1&limit=10" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions?page=1&limit=10",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10},
)
print(res.json())

Example response

{
  "status": true,
  "message": "Subscriptions retrieved successfully",
  "data": [
    {
      "id": "sub_001",
      "packageName": "Pro Plan",
      "amount": "500000",
      "interval": "monthly",
      "businessId": "biz_xyz789",
      "clientId": "client_001"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 3,
    "totalPages": 1
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response