POST
/
v5
/
company
/
billing_items
curl --request POST \
  --url https://api.whop.com/api/v5/company/billing_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "identifier": "<string>",
  "name": "<string>",
  "product_id": "<string>",
  "billing_type": "structured",
  "currency": "usd",
  "unit_name": "<string>",
  "unit_per_price": 123,
  "unit_price": 123
}'
{
  "id": "<string>",
  "identifier": "<string>",
  "name": "<string>",
  "status": "active",
  "product_id": "<string>",
  "app_id": "<string>",
  "billing_type": "structured",
  "created_at": 123,
  "currency": "usd",
  "unit_name": "<string>",
  "unit_per_price": 123,
  "unit_price": 123
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
identifier
string

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

name
string
required

The name of the billing item.

product_id
string
required

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

billing_type
enum<string>
required

The billing type of the billing item.

Available options:
structured,
variable
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
unit_name
string

The name of the unit for the billing item. Only for structured billing items.

unit_per_price
integer

The unit per price / unit amount for the billing item. Only for structured billing items.

unit_price
number

The unit price for the billing item. Only for structured billing items.

Response

201 - application/json
id
string
required

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

identifier
string

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

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
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.

Was this page helpful?

Retrieve a PaymentList Billing Items