POST
/
v5
/
app
/
billing_usages
curl --request POST \
  --url https://api.whop.com/api/v5/app/billing_usages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "billing_item_id": "<string>",
  "billing_item_identifier": "<string>",
  "company_id": "<string>",
  "membership_id": "<string>",
  "amount": 123,
  "quantity": 123
}'
{
  "id": "<string>",
  "created_at": 123,
  "company_id": "<string>",
  "app_id": "<string>",
  "membership_id": "<string>",
  "billing_item_id": "<string>",
  "quantity": 123,
  "amount": 123,
  "receipt_id": "<string>"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
billing_item_id
string

The ID of the billing item, which will look like bi_*************. Supply this or the billing_item_identifier.

billing_item_identifier
string

The identifier of the billing item, which will be a string. Supply this or the billing_item_id.

company_id
string

The ID of the company, which will look like biz_*************. Supply this or the membership_id.

membership_id
string

The ID of the membership, which will look like mem_*************. Supply this or the company_id.

amount
number

The amount to charge, if the billing item is variable.

quantity
number

The quantity to charge for the billing item, if the billing item is structured.

Response

201 - application/json
id
string
required

The ID of the billing usage, which will look like bu_*************

created_at
number
required

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

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_*************

membership_id
string
required

The ID of the membership, which will look like mem_*************

billing_item_id
string
required

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

quantity
number

The quantity to charge for the billing item, if the billing item is structured.

amount
number

The amount to charge, if the billing item is variable.

receipt_id
string

The ID of the receipt, which will look like rec_*************

Was this page helpful?

Retrieve a Billing UsageDelete a Billing Usage