PATCH
/
v5
/
company
/
billing_items
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

The ID of the billing item, which will look like bi_*************

Body

application/json
status
enum<string>
required

The status of the billing item.

Available options:
active,
archived

Response

200 - application/json
id
string
required

The ID of the billing item, which will look like bi_*************

name
string
required

The name of the billing item.

status
enum<string>
required

The status of the billing item.

Available options:
active,
archived
product_id
string
required

The ID of the product, which will look like prod_*************

app_id
string
required

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

billing_type
enum<string>
required

The billing type of the billing item.

Available options:
structured,
variable
created_at
integer
required

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

currency
enum<string>
required

The three letter currency code for the billing 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
identifier
string

An identifier for the billing item that is unique across all billing items for the product in respect to the app.

unit_name
string

The name of the unit for the billing item.

unit_per_price
integer

The unit per price / unit amount for the billing item.

unit_price
number

The unit price for the billing item.