Create plan

Time	Status	User Agent
Retrieving recent requests…

name

string

required

length ≤ 255

Plan name.

description

string

required

Plan description.

currency

string

enum

required

The currency of the plan represented by a string of alphabetic code from ISO 4217 Currency codes

usd - usd
cad - cad
eur - eur
aed - aed
afn - afn
all - all
amd - amd
ars - ars
aud - aud
azn - azn
bam - bam
bdt - bdt
bgn - bgn
bhd - bhd
bif - bif
bnd - bnd
bob - bob
brl - brl
bwp - bwp
byn - byn
bzd - bzd
cdf - cdf
chf - chf
clp - clp
cny - cny
cop - cop
crc - crc
cve - cve
czk - czk
djf - djf
dkk - dkk
dop - dop
dzd - dzd
eek - eek
egp - egp
ern - ern
etb - etb
gbp - gbp
gel - gel
ghs - ghs
gnf - gnf
gtq - gtq
hkd - hkd
hnl - hnl
hrk - hrk
huf - huf
idr - idr
ils - ils
inr - inr
iqd - iqd
irr - irr
isk - isk
jmd - jmd
jod - jod
jpy - jpy
kes - kes
khr - khr
kmf - kmf
krw - krw
kwd - kwd
kzt - kzt
lbp - lbp
lkr - lkr
ltl - ltl
lvl - lvl
lyd - lyd
mad - mad
mdl - mdl
mga - mga
mkd - mkd
mmk - mmk
mop - mop
mur - mur
mxn - mxn
myr - myr
mzn - mzn
nad - nad
ngn - ngn
nio - nio
nok - nok
npr - npr
nzd - nzd
omr - omr
pab - pab
pen - pen
php - php
pkr - pkr
pln - pln
pyg - pyg
qar - qar
ron - ron
rsd - rsd
rub - rub
rwf - rwf
sar - sar
sdg - sdg
sek - sek
sgd - sgd
sos - sos
syp - syp
thb - thb
tnd - tnd
top - top
try - try
ttd - ttd
twd - twd
tzs - tzs
uah - uah
ugx - ugx
uyu - uyu
uzs - uzs
vef - vef
vnd - vnd
xaf - xaf
xof - xof
yer - yer
zar - zar
zmk - zmk
zwl - zwl
mru - mru
USD - USD
CAD - CAD
EUR - EUR
AED - AED
AFN - AFN
ALL - ALL
AMD - AMD
ARS - ARS
AUD - AUD
AZN - AZN
BAM - BAM
BDT - BDT
BGN - BGN
BHD - BHD
BIF - BIF
BND - BND
BOB - BOB
BRL - BRL
BWP - BWP
BYN - BYN
BZD - BZD
CDF - CDF
CHF - CHF
CLP - CLP
CNY - CNY
COP - COP
CRC - CRC
CVE - CVE
CZK - CZK
DJF - DJF
DKK - DKK
DOP - DOP
DZD - DZD
EEK - EEK
EGP - EGP
ERN - ERN
ETB - ETB
GBP - GBP
GEL - GEL
GHS - GHS
GNF - GNF
GTQ - GTQ
HKD - HKD
HNL - HNL
HRK - HRK
HUF - HUF
IDR - IDR
ILS - ILS
INR - INR
IQD - IQD
IRR - IRR
ISK - ISK
JMD - JMD
JOD - JOD
JPY - JPY
KES - KES
KHR - KHR
KMF - KMF
KRW - KRW
KWD - KWD
KZT - KZT
LBP - LBP
LKR - LKR
LTL - LTL
LVL - LVL
LYD - LYD
MAD - MAD
MDL - MDL
MGA - MGA
MKD - MKD
MMK - MMK
MOP - MOP
MUR - MUR
MXN - MXN
MYR - MYR
MZN - MZN
NAD - NAD
NGN - NGN
NIO - NIO
NOK - NOK
NPR - NPR
NZD - NZD
OMR - OMR
PAB - PAB
PEN - PEN
PHP - PHP
PKR - PKR
PLN - PLN
PYG - PYG
QAR - QAR
RON - RON
RSD - RSD
RUB - RUB
RWF - RWF
SAR - SAR
SDG - SDG
SEK - SEK
SGD - SGD
SOS - SOS
SYP - SYP
THB - THB
TND - TND
TOP - TOP
TRY - TRY
TTD - TTD
TWD - TWD
TZS - TZS
UAH - UAH
UGX - UGX
UYU - UYU
UZS - UZS
VEF - VEF
VND - VND
XAF - XAF
XOF - XOF
YER - YER
ZAR - ZAR
ZMK - ZMK
ZWL - ZWL
MRU - MRU

amount

string

required

^-?\d{0,12}(?:\.\d{0,2})?$

Plan's base amount to be used in subscription invoices.

one_time_fee

string

^-?\d{0,12}(?:\.\d{0,2})?$

One-time fee will be added once to the first subscription invoice when subscribing to this plan.

trial_period

integer

≥ 0

Number of trial days before the first recurring cycle.

recurrency

integer

required

≥ 1

The interval at which subscription is charged. Subscribers will pay every 'Recurrency x Recurrency_unit'.

recurrency_unit

string

enum

required

The time unit used to define the recurrency. DAY and MONTH are supported.

DAY - DAY
MONTH - MONTH

Allowed:

recurring_cycles

integer

≥ 1

The total number of payment cycles in the subscription lifetime. if empty the subscription will be charged forever till canceled.

discount_amount

string

^-?\d{0,12}(?:\.\d{0,2})?$

Discount amount applied. Discount amount and percentage cannot be set together.

discount_percentage

string

^-?\d{0,3}(?:\.\d{0,2})?$

Discount percentage applied. Discount amount and percentage cannot be set together.

discount_cycles

integer

≥ 1

How many cycles the discount will be applied to.

200

400

401