Skip to main content
POST
/
v5
/
app
/
line_items
Create a Line Item
curl --request POST \
  --url https://{defaultHost}/v5/app/line_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "company_id": "<string>",
  "amount": 123,
  "base_currency": "usd",
  "name": "<string>",
  "description": "<string>",
  "allow_multiple_quantity": true,
  "metadata": {}
}'
{
  "id": "<string>",
  "created_at": 123,
  "company_id": "<string>",
  "app_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "amount": 123,
  "base_currency": "usd",
  "allow_multiple_quantity": true,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Body

application/json
​
company_id
string
required

The ID of the company to create the line item for, which will look like biz_*************

​
amount
number
required

The amount (price) for the line item.

​
base_currency
enum<string>
required

A three letter currency code for the line item.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub
​
name
string
required

The name of the line item.

​
allow_multiple_quantity
boolean
required

Whether or not the line item can be purchased as multiple quantity.

​
description
string

A textual description for the line item.

​
metadata
object

A JSON object containing any additional metadata for the line item.

Response

201 - application/json

line item created

​
id
string
required

The ID of the line item, which will look like li_*************

​
created_at
number
required

The date the line item was created.

​
company_id
string
required

The ID of the company, which will look like biz_*************

​
app_id
string
required

The ID of the app, which will look like app_*************

​
name
string
required

The name of the line item.

​
amount
number
required

The amount (price) for the line item.

​
base_currency
enum<string>
required

A three letter currency code for the line item.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub
​
allow_multiple_quantity
boolean
required

Whether or not the line item can be purchased as multiple quantity.

​
metadata
object
required

A JSON object containing any additional metadata for the line item.

​
description
string | null

A textual description for the line item.