Find Billable Items

POST

companies

{company_id}

billable_items

find

Find Billable Items

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_items/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "sort_key": "createdAtDesc",
  "include_meta": true,
  "query": {
    "external_name": "<unknown>",
    "name": "<unknown>",
    "state": "<unknown>"
  }
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "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

pagination

object

required

The pagination parameters for the request

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

default:20

Required range: 0 <= x <= 200

sort_key

enum<string>

default:createdAtDesc

required

Available options:

createdAtDesc,

createdAtAsc,

updatedAtAsc,

updatedAtDesc

include_meta

boolean | null

Whether to include additional metadata in the pagination response such the number of total results

query

object

The query criteria for the request

Show child attributes

query.external_name

null | string

query.name

null | string

query.state

null | string

Response

200 - application/json

pagination

object

Show child attributes

pagination.from_key

null | string

pagination.limit

integer<int64>

results

object[] | null

Show child attributes

results.company_id

string

The company ID for the billable item

results.created_at

string<date-time>

The date the billable item was created

results.description

string

Any description attached to the billable item

results.display_type

string

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

results.editable

boolean

Whether the billable item can be further edited

results.external_name

string

The public name of the billable item

results.id

string

The ID of the billable item in Maple

results.name

string

The name of the billable item

results.standard

boolean

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

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

results.updated_at

string<date-time>

The date the billable item was last updated

Update Billable ItemUpdate a billable item

⌘I

Find Billable Items

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_items/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "sort_key": "createdAtDesc",
  "include_meta": true,
  "query": {
    "external_name": "<unknown>",
    "name": "<unknown>",
    "state": "<unknown>"
  }
}
'

{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "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"
    }
  ]
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response