Sign in
Space Billing

Retrieve a statement

Returns one month's statement as JSON: the totals for the month, company-wide usage by kind, and usage per project. Filter the breakdown with kind and project. /api/space/billing_statement.json returns the same response. For the same statement as a file, use Download a statement as CSV or Download a statement as PDF.

The statement is computed on request from the usage reporting pipeline, so the response is 502 when that pipeline is unavailable.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

get/api/space/billing_statement

Query parameters

monthstring required

The calendar month, as YYYY-MM. A month before the space existed is rejected with month_precedes_space_creation, and a future month with month_is_in_the_future.

kindstring[]

Return only these usage kinds in usage_by_kind and in each project's breakdown. Repeat the parameter for each kind.

projectUuid[]

Restrict the per-project breakdown to these project ids. Repeat the parameter for each project.

Response

The request has succeeded.

type'billing_statement' required

The object type. Always billing_statement.

monthstring required

The calendar month the statement covers, as YYYY-MM.

Example response

{
  "type": "billing_statement",
  "month": "2026-07",
  "summary": {
    "usage_in_microdollars": 4820000,
    "usage_in_dollars": 4.82,
    "carrier_fees_in_microdollars": 120000,
    "carrier_fees_in_dollars": 0.12,
    "adjustments": [
      {
        "kind": "pstn_outbound",
        "description": "Outbound Voice Minutes",
        "amount_in_microdollars": 4820000,
        "amount_in_dollars": 4.82
      }
    ]
  },
  "usage_by_kind": [
    {
      "kind": "pstn_outbound",
      "description": "Outbound Voice Minutes",
      "amount_in_microdollars": 4820000,
      "amount_in_dollars": 4.82
    }
  ],
  "projects": [
    {
      "name": "Root Project",
      "amount_in_microdollars": 4820000,
      "amount_in_dollars": 4.82,
      "usage_by_kind": [
        {
          "kind": "pstn_outbound",
          "description": "Outbound Voice Minutes",
          "amount_in_microdollars": 4820000,
          "amount_in_dollars": 4.82
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.