Skip to main content
GET
/
frontend
/
api
/
v1
/
billing
/
plan
/
{plan-id}
Get plan details
curl --request GET \
  --url https://{host}/frontend/api/v1/billing/plan/{plan-id} \
  --header 'Authorization: Bearer <token>'
{
  "active": true,
  "amount": {
    "fixed": 123,
    "max": 123,
    "min": 123,
    "preset": 123,
    "tiers": [
      123
    ]
  },
  "created": "2023-11-07T05:31:56Z",
  "currency": "aed",
  "description": "<string>",
  "details": {},
  "id": "<string>",
  "name": "<string>",
  "recurring-interval": "month",
  "stripe-price": "<unknown>",
  "type": "recurring"
}

Authorizations

​
Authorization
string
header
required

API Key Security (Header).

Path Parameters

​
plan-id
string
required

Response

OK

​
active
boolean
​
amount
object
​
created
string<date-time>
​
currency
enum<string>
Available options:
aed,
afn,
all,
amd,
ang,
aoa,
ars,
aud,
awg,
azn,
bam,
bbd,
bdt,
bgn,
bif,
bmd,
bnd,
bob,
brl,
bsd,
bwp,
bzd,
cad,
cdf,
chf,
clp,
cny,
cop,
crc,
cve,
czk,
djf,
dkk,
dop,
dzd,
eek,
egp,
etb,
eur,
fjd,
fkp,
gbp,
gel,
gip,
gmd,
gnf,
gtq,
gyd,
hkd,
hnl,
hrk,
htg,
huf,
idr,
ils,
inr,
isk,
jmd,
jpy,
kes,
kgs,
khr,
kmf,
krw,
kyd,
kzt,
lak,
lbp,
lkr,
lrd,
lsl,
ltl,
lvl,
mad,
mdl,
mga,
mkd,
mnt,
mop,
mro,
mur,
mvr,
mwk,
mxn,
myr,
mzn,
nad,
ngn,
nio,
nok,
npr,
nzd,
pab,
pen,
pgk,
php,
pkr,
pln,
pyg,
qar,
ron,
rsd,
rub,
rwf,
sar,
sbd,
scr,
sek,
sgd,
shp,
sll,
sos,
srd,
std,
svc,
szl,
thb,
tjs,
top,
try,
ttd,
twd,
tzs,
uah,
ugx,
usd,
uyu,
uzs,
vef,
vnd,
vuv,
wst,
xaf,
xcd,
xof,
xpf,
yer,
zar,
zmw
​
description
string
​
details
object
​
id
string
​
name
string
​
recurring-interval
enum<string>
Available options:
month,
day,
week,
year
​
stripe-price
any
​
type
enum<string>
Available options:
recurring,
one_time