Plans

Create plan

Changed on Nov 3, 2026

Defines the price and interval subscriptions bill on. Store the returned code: it is how subscriptions reference the plan. Treat plans as immutable once anything is subscribed to them.

post/v1/plans

Request

Base URL
https://api.kyshi.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/plans/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

descriptionstring required

amountnumber required

localCurrency'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD' required

amountCurrency'settlement' | 'local'

How to interpret 'amount'. Defaults to 'local' for backward compatibility.

settlementCurrency'USD' | 'GBP' | 'EUR' | 'CAD' | 'CNY' | 'USDC' | 'USDT'

Settlement currency. Auto-detected from business if not provided.

limitnumber

hostedPageboolean

sendSmsboolean

sendInvoicesboolean

Example request

{
  "name": "Monthly Pro",
  "description": "Monthly access to the Pro plan",
  "interval": "monthly",
  "amount": 5000,
  "localCurrency": "NGN",
  "amountCurrency": "local",
  "settlementCurrency": "USD",
  "limit": 12,
  "hostedPage": true,
  "sendInvoices": true
}

Response

Success.

statusboolean required

true on success.

messagestring required

codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

Nov 3, 20264aed77604588 Revision changes
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added the new CNY enum value to the request property
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history