API reference

Usage and billing

Consumption, plan and platform identity.

Usage by day, category, country or number#

GET/usage

Authentication: API key (Bearer pk_…), or console session (Bearer ses_… with the X-Environment-Id header)
Required scope: usage:read

The Meta cost is an ESTIMATE calculated with the configured price grid; unpricedMessages counts billable messages with no configured price. BrefPoint fees are separate and never added to the Meta cost.

Parameters

Name	Location	Type	Description
`from`	query	string	Start (inclusive), ISO 8601. Default: start of the current month (UTC)
`to`	query	string	End (exclusive), ISO 8601
`groupBy`	query	string	Grouping: `day` (default), `category`, `country` or `phone_number`.Values: day, category, country, phone_number

Example

bash

curl "$INBOX_API/usage" \
  -H "Authorization: Bearer $INBOX_KEY"

javascript

const res = await fetch(`${process.env.INBOX_API}/usage`, {
  headers: {
    Authorization: `Bearer ${process.env.INBOX_KEY}`,
  },
});
const data = await res.json();

python

import os
import requests

res = requests.get(
    f"{os.environ['INBOX_API']}/usage",
    headers={
        "Authorization": f"Bearer {os.environ['INBOX_KEY']}",
    },
)
print(res.json())

php

<?php

$ch = curl_init(getenv('INBOX_API') . '/usage');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('INBOX_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Response · 200 OK

{
  "from": "2026-11-01T00:00:00.000Z",
  "to": "2026-12-01T00:00:00.000Z",
  "groupBy": "day",
  "totals": {
    "messages": 0,
    "billableMessages": 0,
    "notBillableMessages": 0,
    "unpricedMessages": 0,
    "metaCostEstimate": {},
    "platformFee": {}
  },
  "buckets": [],
  "metaCostIsEstimate": true
}

Plan, usage for the period and limits (portal)#

GET/billing/overview

Authentication: Portal session (Bearer ses_…)

Example

bash

curl "$INBOX_API/billing/overview" \
  -H "Authorization: Bearer $INBOX_SESSION"

javascript

const res = await fetch(`${process.env.INBOX_API}/billing/overview`, {
  headers: {
    Authorization: `Bearer ${process.env.INBOX_SESSION}`,
  },
});
const data = await res.json();

python

import os
import requests

res = requests.get(
    f"{os.environ['INBOX_API']}/billing/overview",
    headers={
        "Authorization": f"Bearer {os.environ['INBOX_SESSION']}",
    },
)
print(res.json())

php

<?php

$ch = curl_init(getenv('INBOX_API') . '/billing/overview');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('INBOX_SESSION'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Response · 200 OK

{
  "plan": {
    "id": "654e934f-a17e-4c05-8964-b1febb33b2b5",
    "code": "free",
    "name": "Gratuit",
    "monthlyPriceAmount": null,
    "currency": null,
    "includedMessages": 100,
    "hardMessageLimit": 100,
    "maxConnectedBusinesses": 1,
    "maxNumbersPerBusiness": 1,
    "overageFeePerMessage": 0,
    "logRetentionDays": 3
  },
  "period": {
    "start": "2026-11-01T00:00:00.000Z",
    "end": "2026-12-01T00:00:00.000Z"
  },
  "messages": {
    "used": 0,
    "included": 100,
    "hardLimit": 100
  },
  "connectedBusinesses": {
    "used": 0,
    "max": 1
  }
}

Commercial and legal identity of the platform (public)#

GET/platform

Authentication: None (public)

Example

bash

curl "$INBOX_API/platform"

javascript

const res = await fetch(`${process.env.INBOX_API}/platform`, {
  headers: {
  },
});
const data = await res.json();

python

import os
import requests

res = requests.get(
    f"{os.environ['INBOX_API']}/platform",
)
print(res.json())

php

<?php

$ch = curl_init(getenv('INBOX_API') . '/platform');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

Response · 200 OK

{
  "brand": {
    "name": "Bref Point Inbox",
    "tagline": "One API. Every conversation.",
    "website": null,
    "supportEmail": null
  },
  "legal": {
    "name": "Labred Industry",
    "address": null,
    "taxId": null
  },
  "notice": "Bref Point Inbox is an independent product, published by Labred Industry. It is neither published nor endorsed by Meta."
}