Reference
- Pricing
- Checkout
- Contracts
- Credits
- Customer Dashboards
- Customers
- Entitlements
- Events
- Invoices
- Objects
- One-Time
- Payments
- Metrics
- Subscriptions
Pricing
Find Billable Metrics
Find billable metrics created through the Maple dashboard
POST
/
companies
/
{company_id}
/
billable_metrics
/
find
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_metrics/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": "<string>",
"limit": 20
},
"query": {
"external_name": "<string>",
"item_id": "<string>",
"name": "<string>",
"state": "<string>"
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": "<string>",
"limit": 123
},
"results": [
{
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"editable": true,
"external_name": "<string>",
"id": "<string>",
"item_id": "<string>",
"metering_rule": {
"aggregator": "<string>",
"group_keys": [
"<string>"
],
"property": "<string>",
"rule": {
"comparator": {
"items": [
{}
],
"left_item": {
"comparator": {},
"item_type": "<string>",
"property": "<string>",
"value": "<string>"
},
"right_item": {
"comparator": {},
"item_type": "<string>",
"property": "<string>",
"value": "<string>"
},
"type": "<string>"
}
}
},
"name": "<string>",
"standard": true,
"state": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
Company ID. It should have a prefix 'cmp_'.
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/billable_metrics/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": "<string>",
"limit": 20
},
"query": {
"external_name": "<string>",
"item_id": "<string>",
"name": "<string>",
"state": "<string>"
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": "<string>",
"limit": 123
},
"results": [
{
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"editable": true,
"external_name": "<string>",
"id": "<string>",
"item_id": "<string>",
"metering_rule": {
"aggregator": "<string>",
"group_keys": [
"<string>"
],
"property": "<string>",
"rule": {
"comparator": {
"items": [
{}
],
"left_item": {
"comparator": {},
"item_type": "<string>",
"property": "<string>",
"value": "<string>"
},
"right_item": {
"comparator": {},
"item_type": "<string>",
"property": "<string>",
"value": "<string>"
},
"type": "<string>"
}
}
},
"name": "<string>",
"standard": true,
"state": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.