---
title: "Get billing summary for one reporting period"
method: GET
path: "/v1/billing/summary"
tags: ["Billing"]
---

# Get billing summary for one reporting period

`GET /v1/billing/summary`

## Request

- Base URL: `https://docs.grepr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.grepr.ai/v1/billing/summary`
- Auth: OpenID Connect (`https://grepr-prod.us.auth0.com/.well-known/openid-configuration`)

Returns the per-period payload — contract bounds, reporting-period descriptor, and plan-specific commitment summary — for the authenticated user's organization. When no period is supplied, defaults to the period containing today.

## Query parameters

- `period` string

## Response `200`

Contract + reporting period + plan summary.

- BillingSummaryResponse: Per-period billing summary: contract bounds, period, summary.
  - `contract` Contract, required: Metadata about the contract.
    - `endDate` string, date, required: Inclusive contract end date — the last day this contract covers. For renewed or recast contracts, this is the day before the next contract's start.
    - `startDate` string, date, required: Inclusive contract start date.
  - `period` PeriodEntry, required: One reporting period — dropdown entry plus bounds for display.
    - `current` boolean: True if this entry's period contains today.
    - `endDate` string, date, required: Inclusive period end date — the last day in the period.
    - `id` string, required: Canonical period identifier used in the URL — "YYYY-MM-DD" (the period's start date) for both monthly and annual plans.
    - `startDate` string, date, required: Inclusive period start date.
  - `summary` union, required: Plan-specific usage summary.
    - object: Commitment summary for Monthly + PAYG plans.
      - `chargedThisPeriod` number: Invoice total for this reporting period.
      - `type` string, required
    - object: Commitment summary for Monthly + Credit Pool plans.
      - `credits` number, required: Monthly recurring committed dollar amount.
      - `total` number, required: Gross consumption in dollars for this reporting period.
      - `type` string, required
    - object: Commitment summary for Annual - Credit Pool plans.
      - `annualCommitment` number, required: Yearly committed dollar amount.
      - `usedCumulative` number, required: Cumulative dollar value of consumption since contract start.
      - `usedThisPeriod` number, required: Dollar value of consumption during this reporting period.
      - `type` string, required
    - object: Commitment summary for Annual - Data Processing plans.
      - `rows` MeteredDimensionCommitment[], required: One row per metric the customer is pre-committed on (e.g. Data Processing GB, Compute Units).
        - `annualCommitment` number, required: Annually committed quantity for this metric.
        - `metric` string, required: Metric name (e.g. "Data Processing GB", "Compute Units").
        - `usedCumulative` number, required: Quantity consumed cumulatively since the contract started.
        - `usedThisPeriod` number, required: Quantity consumed during the reporting period.
      - `type` string, required
    - object: Pre-commitment summary for Annual + SaaS plans.
      - `rows` MeteredDimensionCommitment[], required: One row per metric the customer is pre-committed on, ordered by the configured displayed brick id list.
        - `annualCommitment` number, required: Annually committed quantity for this metric.
        - `metric` string, required: Metric name (e.g. "Data Processing GB", "Compute Units").
        - `usedCumulative` number, required: Quantity consumed cumulatively since the contract started.
        - `usedThisPeriod` number, required: Quantity consumed during the reporting period.
      - `type` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: No billing record exists, no eligible subscription owns the requested period, or the subscription's plan template is unrecognized.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/grepr/apis/grepr-api.md) - [All operations](https://skmtc.dev/grepr/apis/grepr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grepr/apis/grepr-api/revisions/2a5ce03a0bf0?raw)