Skip to main content
POST
/
companies
/
{company_id}
/
billable_items
Create Billable Item
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "display_type": null,
  "external_name": "<string>",
  "name": "<string>",
  "type": "CUSTOM_USAGE"
}'
{
  "company_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "display_type": "<string>",
  "editable": true,
  "external_name": "<string>",
  "id": "<string>",
  "name": "<string>",
  "standard": true,
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
name
string
required

The name of the billable item

​
type
enum<string>
required

The type of billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item

Available options:
CUSTOM_USAGE,
CUSTOM_OBJ
​
description
string

The description of the billable item

​
display_type
enum<string> | null

The display units of the billable item which can be UNITS, AMOUNT, THOUSAND_UNITS or MILLION_UNITS, based on whether they need to be displayed as units, amounts, thousands of units (K) or millions of units (M)

Available options:
UNITS,
AMOUNT,
THOUSAND_UNITS,
MILLION_UNITS
​
external_name
string

The public name of the billable item

Response

200 - application/json

OK

​
company_id
string

The company ID for the billable item

​
created_at
string<date-time>

The date the billable item was created

​
description
string

Any description attached to the billable item

​
display_type
string

The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS

​
editable
boolean

Whether the billable item can be further edited

​
external_name
string

The public name of the billable item

​
id
string

The ID of the billable item in Maple

​
name
string

The name of the billable item

​
standard
boolean

Whether this is a standard billable item in Maple or a custom billable item

​
type
string

The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item

​
updated_at
string<date-time>

The date the billable item was last updated