Référence API

Usage et facturation

Consommation, plan et identité de la plateforme.

Consommation par jour, catégorie, pays ou numéro#

GET/usage

Authentification: Clé API (Bearer pk_…), ou session de la console (Bearer ses_… avec l'en-tête X-Environment-Id)
Portée requise: usage:read

Le coût Meta est une ESTIMATION calculée avec la grille tarifaire configurée ; unpricedMessages compte les messages facturables sans tarif configuré. Les frais BrefPoint sont séparés et jamais ajoutés au coût Meta.

Paramètres

Nom	Emplacement	Type	Description
`from`	requête	string	Début (inclus), ISO 8601. Défaut : début du mois en cours (UTC)
`to`	requête	string	Fin (exclue), ISO 8601
`groupBy`	requête	string	Regroupement : `day` (défaut), `category`, `country` ou `phone_number`.Valeurs : day, category, country, phone_number

Exemple

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);

Réponse · 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, consommation de la période et limites (portail)#

GET/billing/overview

Authentification: Session du portail (Bearer ses_…)

Exemple

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);

Réponse · 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
  }
}

Identité commerciale et légale de la plateforme (publique)#

GET/platform

Authentification: Aucune (publique)

Exemple

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);

Réponse · 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 est un produit indépendant, édité par Labred Industry. Il n'est ni édité, ni approuvé par Meta."
}