---
title: "Gets the overview for a billing period by its ID."
method: GET
path: "/billing-period/{billingPeriodId}"
tags: ["Billing"]
---

# Gets the overview for a billing period by its ID.

`GET /billing-period/{billingPeriodId}`

## Path parameters

- `billingPeriodId` string, required

## Response `200`

OK

- GetBillingPeriodOverviewEndpointOutput
  - `id` string, required — The billing period ID.
  - `startDate` string, date-time, required — The start date of the billing period.
  - `endDate` string, date-time, required — The end date of the billing period.
  - `status` 'Open' | 'Invoiced' | 'Void' | 'Reconciling', required
  - `totalGrossCost` number, double, required — The total gross cost before discounts.
  - `totalDiscount` number, double, required — The total discount amount.
  - `totalNetCost` number, double, required — The total net cost after discounts.
  - `totalResponseCount` integer, required — The total number of billable responses.
  - `lineItems` ILineItem[], required — The line items (running cost, platform fees, refunds, volume discounts).
    - union
      - object
        - `_t` 'MinimumSpendCommitment', required
        - `id` string, nullable
        - `name` string, required
        - `amount` number, double, required
        - `comment` string, nullable
      - object
        - `_t` 'Other', required
        - `id` string, required
        - `name` string, required
        - `amount` number, double, required
        - `comment` string, nullable
      - object
        - `_t` 'PlatformFee', required
        - `id` string, required
        - `name` string, required
        - `amount` number, double, required
        - `comment` string, nullable
      - object
        - `_t` 'Refund', required
        - `id` string, required
        - `name` string, required
        - `amount` number, double, required
        - `comment` string, nullable
      - object
        - `_t` 'RunningCost', required
        - `amount` number, double, required
      - object
        - `_t` 'VolumeDiscount', required
        - `amount` number, double, required
        - `effectiveDiscountRatio` number, double, required

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/versions/e42ec51c7b88/schema)