Partners

Monthly usage report

One line per end customer for a calendar month: days live, domains, mailboxes, storage (latest nightly snapshot), sends, bounces and complaints. The input for invoicing your own clients. format=csv downloads a file. Defaults to the current month. Requires partner:read.

get/reports/usage

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/reports/usage
  • Auth: HTTP bearer

Query parameters

monthstring
Example:2026-09

Calendar month, YYYY-MM (UTC). Defaults to the current month.

format'json' | 'csv'

Response

The report

successboolean

Example response

{
  "success": true,
  "data": {
    "month": "2026-09",
    "customers": [
      {
        "monthlyCents": 600,
        "seatCents": 600,
        "bounceRate": 0.004,
        "complaintRate": 0.004
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.