# Usage and billing

Consumption, plan and platform identity.

## Usage by day, category, country or number

`GET /usage`

Authentication: API key, or console session with X-Environment-Id · 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`. |

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

Response 200:

```json
{
  "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

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

Response 200:

```json
{
  "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

```bash
curl "$INBOX_API/platform"
```

Response 200:

```json
{
  "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."
}
```