Skip to main content
POST
/
api
/
v1
/
plans
Create Plan
curl --request POST \
  --url https://api.example.com/api/v1/plans \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "name": "<string>",
  "amount": 123,
  "currency": "NGN",
  "interval_count": 1,
  "trial_period_days": 0
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "amount": 123,
  "currency": "<string>",
  "interval": "<string>",
  "interval_count": 123,
  "trial_period_days": 123,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Headers

x-api-key
string
required

Body

application/json
name
string
required
amount
number
required
interval
enum<string>
required
Available options:
DAILY,
WEEKLY,
MONTHLY,
YEARLY
currency
string
default:NGN
interval_count
integer
default:1
trial_period_days
integer | null
default:0

Response

Successful Response

id
string<uuid>
required
name
string
required
amount
number
required
currency
string
required
interval
string
required
interval_count
integer
required
trial_period_days
integer | null
required
is_active
boolean
required
created_at
string<date-time>
required