Create a plan that can be used to create subscriptions.

-H "x-api-key: your_secret_key"

POST {{host}}/v1/plans

Request Body

Field	Data Type	Required	Description
name	string	Yes	Plan name.
description	string	Yes	Plan description.
interval	string	Yes	Billing interval. Allowed values: `daily`, `weekly`, `monthly`, `quarterly`, `biannually`, `annually`.
amount	number	Yes	Plan amount in major currency units.
localCurrency	string	Yes	Customer billing currency. Supported collection currencies: `NGN`, `KES`, `ZAR`, `GHS`, `XOF`, `USD`.
amountCurrency	string	No	`local` or `settlement`. Defaults to `local`.
settlementCurrency	string	No	Settlement currency. If omitted, Kyshi uses your business settlement account currency.
limit	number	No	Optional plan limit.
hostedPage	boolean	No	Whether to use a hosted page. Defaults to `false`.
sendSms	boolean	No	Whether to send SMS notifications. Defaults to `false`.
sendInvoices	boolean	No	Whether to send invoices. Defaults to `false`.

{
  "name": "Starter",
  "description": "Monthly starter subscription",
  "interval": "monthly",
  "amount": 5000,
  "localCurrency": "NGN",
  "amountCurrency": "local",
  "hostedPage": true,
  "sendInvoices": true
}

{
  "status": true,
  "message": "Success",
  "code": 201,
  "data": {
    "id": "4c4a6413-3f0f-4bc6-97d8-c8f1a8516361",
    "name": "Starter",
    "description": "Monthly starter subscription",
    "interval": "monthly",
    "amount": 5000,
    "settlementAmount": null,
    "settlementCurrency": null,
    "code": "PLN_abc123",
    "mode": "live",
    "hostedPage": true,
    "sendSms": false,
    "sendInvoices": true,
    "isActive": true,
    "createdAt": "2026-05-20T10:15:00.000Z"
  }
}