---
title: "Create plan"
method: POST
path: "/v1/plans"
tags: ["Plans"]
---

# Create plan

`POST /v1/plans`

## Request

- Base URL: `https://api.kyshi.co`
- URL: `https://api.kyshi.co/v1/plans`
- 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)

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.

## Request body

- CreatePlanDto
  - `name` string, required
  - `description` string, required
  - `interval` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'biannually' | 'annually', required
  - `amount` number, 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.
  - `limit` number
  - `hostedPage` boolean
  - `sendSms` boolean
  - `sendInvoices` boolean

## Response `201`

Success.

- object
  - `status` boolean, required: `true` on success.
  - `message` string, required
  - `code` number, required: Mirrors the HTTP status code.
  - `data` object, required: The endpoint-specific payload.
    - `id` string, required
    - `name` string, required
    - `amount` number, required
    - `currency` string, required
    - `interval` string
    - `isActive` boolean
    - `createdAt` string

## Other responses

- `400`: Missing or invalid request parameter.
- `401`: No valid API key provided.
- `403`: The API key lacks permission for this request.
- `404`: Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.
- `422`: Business rule failure, such as an unsupported currency or insufficient balance.
- `500`: Something went wrong on Kyshi’s end.

## Changes

- **2026-11-03** `4aed77604588`: 1 breaking, 4 warning, 9 info
  - the response's body type changed from `object` to no type for status `201`
  - removed the optional property `code` from the response with the `201` status
  - removed the optional property `data` from the response with the `201` status
  - removed the optional property `message` from the response with the `201` status
  - …10 more

[Operation history](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/changes/v1/plans/post.md)

---

[API](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api.md) - [All operations](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/revisions/4aed77604588?raw)