Skip to main content

​
Endpoint

POST /clients/business/subscriptions

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Request body

​
amount
string
required
The billing amount for the subscription, in kobo.
​
packageName
string
A name for the subscription package, e.g. "Pro Plan".
​
interval
string
The billing interval. Expected values may include "monthly", "weekly", or "daily".
TODO — Confirm the exact accepted values for interval before publishing.

​
Response

​
status
boolean
true on success.
​
message
string
Confirmation message.

​
Code examples

curl -X POST https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/subscriptions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "500000",
    "packageName": "Pro Plan",
    "interval": "monthly"
  }'

​
Example response

{
  "status": true,
  "message": "Subscription created successfully"
}