Skip to main content
POST
Create a plan

Authorizations

Authorization
string
header
required

Paste your secret key as the bearer token: sk_test_… (test) or sk_live_… (live). That is all a normal API call needs. OAuth access tokens from POST /v1/oauth/token also work, but a client id/secret is only for platforms acting on another tenant's behalf, not for your own integration.

Body

application/json
name
string
required
Example:

"Pro Monthly"

amount
integer
required

Minor units (kobo).

Example:

500000

interval
enum<string>
required
Available options:
hour,
day,
week,
month,
quarter,
biannual,
year
currency
string
default:NGN
intervalCount
integer
default:1
trialDays
integer
default:0
maxCycles
integer

Stop after N successful charges. Omit for forever.

reminderDays
integer[]
metadata
object

Response

Created

id
string
name
string
amount
integer
currency
string
interval
enum<string>
Available options:
hour,
day,
week,
month,
quarter,
biannual,
year
intervalCount
integer
trialDays
integer
maxCycles
integer | null
createdAt
string<date-time>