POST
/
v5
/
app
/
line_items

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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,
cop,
ron,
thb
name
string
required

The name of the line item.

description
string

A textual description for the line item.

allow_multiple_quantity
boolean
required

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

metadata
object

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

Response

201 - application/json
id
string
required

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

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,
cop,
ron,
thb
description
string

A textual description for the line item.

allow_multiple_quantity
boolean
required

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

metadata
object

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

name
string
required

The name of the line item.

created_at
integer
required

The date the line item was created as a unix timestamp.